php man page for pspell_store_replacement

PSPELL_STORE_REPLACEMENT(3)						 1					       PSPELL_STORE_REPLACEMENT(3)

pspell_store_replacement - Store a replacement pair for a word

SYNOPSIS
       bool pspell_store_replacement (int  $dictionary_link, string  $misspelled, string  $correct)

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

PARAMETERS
	      o $dictionary_link
		- A dictionary link identifier, opened with pspell_new_personal(3)

	      o $misspelled
		- The misspelled word.

	      o $correct
		- The fixed spelling for the $misspelled word.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      pspell_store_replacement(3)

	      <?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_link = pspell_new_config($pspell_config);

	      pspell_store_replacement($pspell_link, $misspelled, $correct);
	      pspell_save_wordlist($pspell_link);
	      ?>

NOTES
       Note

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

PHP Documentation Group 											       PSPELL_STORE_REPLACEMENT(3)