CwpSearchEngine

Complexity

Total Complexity

11

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
C	search()	0	31	7
A	getSearchOptions()	0	6	2
A	getSearchQuery()	0	11	1
A	getResult()	0	14	1

<?php

/**
 * Provides interface for generating search results for a SolrIndex
 */
class CwpSearchEngine extends Object {
	
	/**
	 * Default search options
	 *
	 * @var array
	 * @config
	 */
	private static $search_options = array(
		'hl' => 'true'
	);
	
	/**
	 * Additional search options to send to search when spellcheck
	 * is included
	 *
	 * @var array
	 * @config 
	 */
	private static $spellcheck_options = array(
		'spellcheck' => 'true',
		'spellcheck.collate' => 'true',
		// spellcheck.dictionary can also be configured to use '_spellcheck'
		// dictionary when indexing fields under the _spellcheckText column
		'spellcheck.dictionary' => 'default'
	);
	
	/**
	 * Build a SearchQuery for a new search
	 * 
	 * @param string $keywords
	 * @param array $classes
	 * @return SearchQuery
	 */
	protected function getSearchQuery($keywords, $classes) {
		$query = new SearchQuery();

The type SearchQuery was not found. Maybe you did not declare it correctly or list all dependencies?

		$query->classes = $classes;
		$query->search($keywords);
		$query->exclude('SiteTree_ShowInSearch', 0);
        $query->exclude('File_ShowInSearch', 0);

		// Artificially lower the amount of results to prevent too high resource usage.
		// on subsequent canView check loop.
		$query->limit(100);
		return $query;
	}
	
	/**
	 * Get solr search options for this query
	 * 
	 * @param bool $spellcheck True if we should include spellcheck support
	 * @return array
	 */
	protected function getSearchOptions($spellcheck) {
		$options = $this->config()->search_options;
		if($spellcheck) {
			$options = array_merge($options, $this->config()->spellcheck_options);

It seems like $this->config()->spellcheck_options can also be of type integer and string and boolean and double; however, parameter $array2 of array_merge() does only seem to accept null|array, maybe add an additional type check?

It seems like $options can also be of type integer and string and boolean and double; however, parameter $array1 of array_merge() does only seem to accept array, maybe add an additional type check?

		}
		return $options;
	}
	
	/**
	 * Get results for a search term
	 * 
	 * @param string $keywords
	 * @param array $classes
	 * @param SolrIndex $searchIndex
	 * @param int $limit Max number of results for this page
	 * @param int $start Skip this number of records
	 * @param bool $spellcheck True to enable spellcheck
	 * @return CwpSearchResult
	 */
	protected function getResult($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $spellcheck = false) {
		// Prepare options
		$query = $this->getSearchQuery($keywords, $classes);
		$options = $this->getSearchOptions($spellcheck);
		
		// Get results
		$solrResult = $searchIndex->search(
			$query,
			$start,
			$limit,
			$options
		);
		
		return CwpSearchResult::create($keywords, $solrResult);
	}
	
	/**
	 * Get a CwpSearchResult for a given criterea
	 * 
	 * @param string $keywords
	 * @param array $classes
	 * @param SolrIndex $searchIndex
	 * @param int $limit Max number of results for this page
	 * @param int $start Skip this number of records
	 * @param bool $followSuggestions True to enable suggested searches to be returned immediately
	 * @return CwpSearchResult|null
	 */
	public function search($keywords, $classes, $searchIndex, $limit = -1, $start = 0, $followSuggestions = false) {
		if(empty($keywords)) {
			return null;
		}

		try {
			// Begin search
			$result = $this->getResult($keywords, $classes, $searchIndex, $limit, $start, true);
			
			// Return results if we don't need to refine this any further
			if(!$followSuggestions || $result->hasResults() || !$result->getSuggestion()) {
				return $result;
			}
			
			// Perform new search with the suggested terms
			$suggested = $result->getSuggestion();
			$newResult = $this->getResult($suggested, $classes, $searchIndex, $limit, $start, false);
			$newResult->setOriginal($keywords);

			// Compare new results to the original query
			if($newResult->hasResults()) {
				return $newResult;
			} else {
				return $result;
			}

		} catch(Exception $e) {
			SS_Log::log($e, SS_Log::WARN);
		}
		
		return null;
	}
}