interface SearchApiSpellcheckInterface in Search API Spellcheck 7

@file Spellcheck Service Interface and Class.

Hierarchy

• interface \SearchApiSpellcheckInterface

File

includes/SearchApiSpellcheck.inc, line 7

Spellcheck Service Interface and Class.

interface SearchApiSpellcheckInterface {

  /**
   * Takes a string and returns either the string with spelling suggestions or
   * FALSE if none could be found.
   *
   * @param string $original_string
   *   A single word or full sentance.
   *
   * @return
   *   A string if any suggestions could be applied or FALSE if none could be
   *   applied.
   */
  public function suggestString($original_string);

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiSpellcheckInterface::suggestString	public	function	Takes a string and returns either the string with spelling suggestions or FALSE if none could be found.	1