rcube_spellcheck_engine

Interface class for a spell-checking backend

package	Framework
subpackage	Utils

Methods

Default constructor

__construct( $dict,  $lang)

Arguments

$dict

$lang

Set content and check spelling

check(string $text) : boolean

abstract

Arguments

$text

string

Text content for spellchecking

Response

boolean

True when no mispelling found, otherwise false

Returns error message

error() : string

Response

string

Error message

Returns suggestions for the specified word

get_suggestions(string $word) : array

abstract

Arguments

$word

string

The word

Response

array

Suggestions list

Returns misspelled words

get_words(string $text = null) : array

abstract

Arguments

$text

string

The content for spellchecking. If empty content used for check() method will be used.

Response

array

List of misspelled words

Return a list of languages supported by this backend

languages() : array

abstract

Response

array

Indexed list of language codes

Constants

MAX_SUGGESTIONS

MAX_SUGGESTIONS

Properties

lang

lang :

Type(s)

error

error :

Type(s)

dictionary

dictionary :

Type(s)

separator

separator :