EnchantSpell Class Reference

Inheritance diagram for EnchantSpell:

Public Member Functions
&	checkWords ($lang, $words)
	Spellchecks an array of words.
&	getSuggestions ($lang, $word)
	Returns suggestions for a specific word.
&	loopback ()
	Simple loopback function everything that gets in will be send back.
	SpellChecker (&$config)
	Old syntax of class constructor.
	throwError ($str)
	Throws an error message back to the user.

Member Function Documentation

checkWords()

& EnchantSpell::checkWords	(		$lang,
			$words )

Spellchecks an array of words.

Parameters

String	$lang	Selected language code (like en_US or de_DE). Shortcodes like "en" and "de" work with enchant >= 1.4.1
Array	$words	Array of words to check.

Return values

Array

of misspelled words.

Reimplemented from SpellChecker.

getSuggestions()

& EnchantSpell::getSuggestions	(		$lang,
			$word )

Returns suggestions for a specific word.

Parameters

String	$lang	Selected language code (like en_US or de_DE). Shortcodes like "en" and "de" work with enchant >= 1.4.1
String	$word	Specific word to get suggestions for.

Return values

Array

of suggestions for the specified word.

Reimplemented from SpellChecker.

loopback()

& SpellChecker::loopback ( )

inherited

Simple loopback function everything that gets in will be send back.

Parameters

$args..

Arguments.

Return values

{Array}

Array of all input arguments.

SpellChecker()

SpellChecker::SpellChecker ( & $config )

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

throwError()

SpellChecker::throwError ( $str )

inherited

Throws an error message back to the user.

This will stop all execution.

Parameters

{String}

$str Message to send back to user.

---

The documentation for this class was generated from the following file:

• lib/editor/tinymce/plugins/spellchecker/classes/EnchantSpell.php