php8.5
Home/ Manual/ pspell / functions/ pspell_config_repl

pspell_config_repl

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)

Set a file that contains replacement pairs

Description

pspell_config_repl(PSpell\Config $config, string $filename): bool

Set a file that contains replacement pairs.

The replacement pairs improve the quality of the spellchecker. When a word is misspelled, and a proper suggestion was not found in the list, pspell_store_replacement() can be used to store a replacement pair and then pspell_save_wordlist() to save the wordlist along with the replacement pairs.

pspell_config_repl() should be used on a config before calling pspell_new_config().

Parameters

config

Pspell-config

filename

The file should be writable by whoever PHP runs as (e.g. nobody).

Return Values

Success

Changelog

VersionDescription

Examples

pspell_config_repl()

php
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell = pspell_new_config($pspell_config);
pspell_check($pspell, "thecat");
?>

Notes

Note

This function will not work unless you have pspell .11.2 and aspell .32.5 or later.

Source: reference/pspell/functions/pspell-config-repl.xml · from the official PHP manual (php/doc-en)