mirror of
https://github.com/roundcube/roundcubemail.git
synced 2026-03-23 16:26:59 +01:00
a8707ae220
* Assert CS using CI * fix "single_blank_line_at_eof" * fix "statement_indentation" * fix "switch_case_semicolon_to_colon" * fix "control_structure_braces" * fix "statement_indentation" * fix "no_whitespace_in_blank_line" * fix "no_trailing_whitespace_in_comment" * fix "no_trailing_whitespace" * fix "single_space_around_construct" * fix "spaces_inside_parentheses" * fix "ternary_operator_spaces" * fix "trim_array_spaces" * fix "whitespace_after_comma_in_array" * fix "cast_spaces" * fix "unary_operator_spaces" * fix "no_trailing_comma_in_singleline" * fix "ordered_imports" * fix "no_unused_imports" * Check composer.json format * fix CI job name * file header comments are not phpdoc * fix "phpdoc_indent" * fix "braces_position" * fix "phpdoc_types" * fix "no_blank_lines_after_class_opening" * fix "no_multiple_statements_per_line" * fix "multiline_comment_opening_closing" * fix "single_line_empty_body" * fix "non_printable_character" * fix "phpdoc_trim_consecutive_blank_line_separation" * fix "include" * fix "no_mixed_echo_print" --------- Co-authored-by: Aleksander Machniak <alec@alec.pl>
92 lines
2.7 KiB
PHP
92 lines
2.7 KiB
PHP
<?php
|
|
|
|
/*
|
|
+-----------------------------------------------------------------------+
|
|
| This file is part of the Roundcube Webmail client |
|
|
| |
|
|
| Copyright (C) The Roundcube Dev Team |
|
|
| Copyright (C) Kolab Systems AG |
|
|
| |
|
|
| Licensed under the GNU General Public License version 3 or |
|
|
| any later version with exceptions for skins & plugins. |
|
|
| See the README file for a full license statement. |
|
|
| |
|
|
| PURPOSE: |
|
|
| Interface class for a spell-checking backend |
|
|
+-----------------------------------------------------------------------+
|
|
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
|
+-----------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* Interface class for a spell-checking backend
|
|
*
|
|
* @package Framework
|
|
* @subpackage Utils
|
|
*/
|
|
abstract class rcube_spellchecker_engine
|
|
{
|
|
const MAX_SUGGESTIONS = 10;
|
|
|
|
protected $lang;
|
|
protected $error;
|
|
protected $dictionary;
|
|
protected $options = [];
|
|
protected $separator = '/[\s\r\n\t\(\)\/\[\]{}<>\\"]+|[:;?!,\.](?=\W|$)/';
|
|
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
public function __construct($dict, $lang, $options = [])
|
|
{
|
|
$this->dictionary = $dict;
|
|
$this->lang = $lang;
|
|
$this->options = $options;
|
|
}
|
|
|
|
/**
|
|
* Return a list of languages supported by this backend
|
|
*
|
|
* @return array Indexed list of language codes
|
|
*/
|
|
abstract function languages();
|
|
|
|
/**
|
|
* Set content and check spelling
|
|
*
|
|
* @param string $text Text content for spellchecking
|
|
*
|
|
* @return bool True when no misspelling found, otherwise false
|
|
*/
|
|
abstract function check($text);
|
|
|
|
/**
|
|
* Returns suggestions for the specified word
|
|
*
|
|
* @param string $word The word
|
|
*
|
|
* @return array Suggestions list
|
|
*/
|
|
abstract function get_suggestions($word);
|
|
|
|
/**
|
|
* Returns misspelled words
|
|
*
|
|
* @param string $text The content for spellchecking. If empty content
|
|
* used for check() method will be used.
|
|
*
|
|
* @return array List of misspelled words
|
|
*/
|
|
abstract function get_words($text = null);
|
|
|
|
/**
|
|
* Returns error message
|
|
*
|
|
* @return string Error message
|
|
*/
|
|
public function error()
|
|
{
|
|
return $this->error;
|
|
}
|
|
}
|