class SearchApiSpellcheckSolr in Search API Solr 7

Spellcheck class which can provide spelling suggestions. The constructor populates the instance with any suggestions returned by Solr.

Hierarchy

• class \SearchApiSpellcheck implements SearchApiSpellcheckInterface
  • class \SearchApiSpellcheckSolr

File

includes/spellcheck.inc, line 11

Contains the SearchApiSpellcheckSolr class.

class SearchApiSpellcheckSolr extends SearchApiSpellcheck {

  /**
   * Constructs a SearchApiSpellcheckSolr object.
   *
   * If Solr has returned spelling suggestion then loop through them and add
   * them to this spellcheck service.
   *
   * @param object $response
   *   The Solr response object.
   */
  function __construct($response) {
    if (isset($response->spellcheck->suggestions)) {
      $suggestions = $response->spellcheck->suggestions;
      foreach ($suggestions as $word => $data) {
        if (isset($data->suggestion)) {
          foreach ($data->suggestion as $suggestion) {
            $this
              ->addSuggestion(new SearchApiSpellcheckSuggestion($word, $suggestion));
          }
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiSpellcheck::$spellchecks	protected	property
SearchApiSpellcheck::$suggestions	protected	property
SearchApiSpellcheck::addSpellcheck	public	function	This call also maintains a list of sub interances using the same interface. These services are then also check when getSuggestion() is called.
SearchApiSpellcheck::addSuggestion	public	function	Add a suggestion object to the class which is stored and then checked when getSuggestion() is called.
SearchApiSpellcheck::getSuggestion	public	function	Pass a string and if it can be improved by any of the suggestions or sub-services added then return a suggesiton. If no change can be suggested return FALSE.
SearchApiSpellcheck::getSuggestionLinkForArg	public	function	Accepts a Drupal arg number which is used to get the value submitted and returns a link to the current page with whatever value is in the URL argument replaced with a suggestion.
SearchApiSpellcheck::getSuggestionLinkForGet	public	function	Accepts a a query string key which is used to get the value submitted and
SearchApiSpellcheck::suggestString	public	function	Check if any of the added spellcheck suggestions match either all or part of the string. Overrides SearchApiSpellcheckInterface::suggestString
SearchApiSpellcheckSolr::__construct		function	Constructs a SearchApiSpellcheckSolr object.