Description

pspell_new(
    string $language,
    string $spelling = "",
    string $jargon = "",
    string $encoding = "",
    int $mode = 0
): PSpell\Dictionary|false

pspell_new() ouvre un nouveau dictionnaire et retourne une instance de PSpell\Dictionary, pour être utilisée avec d'autres fonctions pspell.

Pour plus d'informations et d'exemples, se reporter au site » http://aspell.net/.

Liste de paramètres

language

Le paramètre de langue language est constitué des deux lettres du codage de langue ISO 639, et du codage optionnel de pays ISO 3166, séparés par un '_'.

spelling

Ce paramètre est nécessaire pour les langues qui ont plus d'une orthographe, comme l'anglais ou le français. Les valeurs reconnues sont 'american', 'british', et 'canadian'.

jargon

Le paramètre jargon contient des informations supplémentaires pour distinguer deux listes de mots qui ont le même marquage de langue et d'orthographe.

encoding

Le paramètre encoding est le type d'encodage des mots. Les valeurs valides sont 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned 32'. Ce paramètre n'ayant pas été testé de façon exhaustive, il convient d'être prudent lors de son utilisation.

mode

Le paramètre mode est le mode de travail du vérificateur d'orthographe. Plusieurs modes sont disponibles :

PSPELL_FAST - Mode rapide (moins de suggestions)
PSPELL_NORMAL - Mode normal (plus de suggestions)
PSPELL_BAD_SPELLERS - Mode lent (beaucoup plus de suggestions)
PSPELL_RUN_TOGETHER - Considère que des mots accolés forment un composé autorisé. Ainsi, "lechat" sera un composé valide. Cette option ne modifie que les résultats retournés par pspell_check(); pspell_suggest() retournera toujours des suggestions.

mode est un masque construit à partir des constantes listées ci-dessus. Cependant, PSPELL_FAST, PSPELL_NORMAL et PSPELL_BAD_SPELLERS sont mutuellement exclusives : on ne doit en utiliser qu'un à la fois.

Valeurs de retour

Retourne une instance de PSpell\Dictionary en cas de succès, ou false si une erreur survient.

Historique

Version	Description
8.1.0	Retourne désormais une instance de PSpell\Dictionary ; auparavant, une resource était retournée.

Exemples

Exemple #1 pspell_new()

<?php
$pspell = pspell_new("en", "", "", "",
                     (PSPELL_FAST|PSPELL_RUN_TOGETHER));
?>