pspell_config_mode
Change the mode number of suggestions returned
Description
bool pspell_config_mode(PSpell\Config $config
, int $mode
)
pspell_config_mode should be used on a config
before calling pspell_new_config. This function
determines how many suggestions will be returned by
pspell_suggest.
Parameters
-
config
-
An PSpell\Config instance.
-
mode
-
The mode parameter is the mode in which spellchecker will work.
There are several modes available:
-
PSPELL_FAST
- Fast mode (least number of
suggestions)
-
PSPELL_NORMAL
- Normal mode (more suggestions)
-
PSPELL_BAD_SPELLERS
- Slow mode (a lot of
suggestions)
Return Values
Returns true
on success or false
on failure.
Examples
Example #1 pspell_config_mode Example
<?php
$pspell_config = pspell_config_create("en");
pspell_config_mode($pspell_config, PSPELL_FAST);
$pspell = pspell_new_config($pspell_config);
pspell_check($pspell, "thecat");
?>