pspell_store_replacement

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

pspell_store_replacementStore a replacement pair for a word

Description

pspell_store_replacement(PSpell\Dictionary $dictionary, string $misspelled, string $correct): bool

pspell_store_replacement() stores a replacement pair for a word, so that replacement can be returned by pspell_suggest() later. In order to be able to take advantage of this function, you have to use pspell_new_personal() to open the dictionary. In order to permanently save the replacement pair, you have to use pspell_config_personal() and pspell_config_repl() to set the path where to save your custom wordlists, and then use pspell_save_wordlist() for the changes to be written to disk.

Parameters

dictionary

An PSpell\Dictionary instance.

misspelled

The misspelled word.

correct

The fixed spelling for the misspelled word.

Return Values

Returns true on success or false on failure.

Changelog

Version Description
8.1.0 The dictionary parameter expects an PSpell\Dictionary instance now; previously, a resource was expected.

Examples

Example #1 pspell_store_replacement()

<?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_store_replacement($pspell$misspelled$correct);
pspell_save_wordlist($pspell);
?>

Notes

Note:

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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top