Refactor spellchecker class into backend subclasses for better extensibility

1 files changed, 84 insertions, 0 deletions

diff --git a/program/lib/Roundcube/rcube_spellcheck_engine.php b/program/lib/Roundcube/rcube_spellcheck_engine.php
new file mode 100644
index 000000000..88e10ac05
--- /dev/null
+++ b/program/lib/Roundcube/rcube_spellcheck_engine.php
@@ -0,0 +1,84 @@
+<?php
+
+/*
+ +-----------------------------------------------------------------------+
+ | This file is part of the Roundcube Webmail client                     |
+ |                                                                       |
+ | Copyright (C) 2011-2013, Kolab Systems AG                             |
+ | Copyright (C) 2008-2013, The Roundcube Dev Team                       |
+ |                                                                       |
+ | 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_spellcheck_engine
+{
+    const MAX_SUGGESTIONS = 10;
+
+    protected $lang;
+    protected $error;
+    protected $dictionary;
+    protected $separator = '/[\s\r\n\t\(\)\/\[\]{}<>\\"]+|[:;?!,\.](?=\W|$)/';
+
+    /**
+     * Default constructor
+     */
+    public function __construct($dict, $lang)
+    {
+        $this->dictionary = $dict;
+        $this->lang = $lang;
+    }
+
+    /**
+     * Set content and check spelling
+     *
+     * @param string $text    Text content for spellchecking
+     *
+     * @return bool True when no mispelling 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;
+    }
+
+}
+