markguinn / silverstripe-shop-search

tasks/BuildVFI.php

Indentation +7 added lines, -7 removed lines

@@ -1,12 +1,12 @@
 <?php
 /**
- * Rebuilds all VirtualFieldIndexes
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 9.26.13
- * @package shop_search
- * @subpackage tasks
- */
+	 * Rebuilds all VirtualFieldIndexes
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 9.26.13
+	 * @package shop_search
+	 * @subpackage tasks
+	 */
 class BuildVFI extends BuildTask
 {
 	protected $title = 'Rebuild Virtual Field Indexes';

code/SearchLog.php

Indentation +50 added lines, -50 removed lines

@@ -8,54 +8,54 @@
  */
 class SearchLog extends DataObject
 {
-    private static $db = array(
-        'Query'         => 'Varchar(255)',
-        'Title'         => 'Varchar(255)', // title for breadcrumbs. any new facets added will be reflected here
-        'Link'          => 'Varchar(255)',
-        'Filters'       => 'Text', // json
-        'NumResults'    => 'Int',
-    );
-
-    private static $has_one = array(
-        'Member'        => 'Member',
-        'ParentSearch'  => 'SearchLog', // used in constructing a search breadcrumb
-    );
-
-
-    /**
-     * Generate the title if needed
-     */
-    protected function onBeforeWrite()
-    {
-        parent::onBeforeWrite();
-        if (!$this->Title) {
-            $this->Title = empty($this->Query) ? "Search" : "Search: {$this->Query}";
-        }
-    }
-
-
-    /**
-     * @return ArrayList
-     */
-    public function getBreadcrumbs()
-    {
-        $out    = new ArrayList();
-        $cur    = $this;
-
-        while ($cur && $cur->exists()) {
-            $out->unshift($cur);
-            $cur = $cur->ParentSearchID > 0 ? $cur->ParentSearch() : null;
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getFiltersArray()
-    {
-        return $this->Filters ? json_decode($this->Filters, true) : array();
-    }
+	private static $db = array(
+		'Query'         => 'Varchar(255)',
+		'Title'         => 'Varchar(255)', // title for breadcrumbs. any new facets added will be reflected here
+		'Link'          => 'Varchar(255)',
+		'Filters'       => 'Text', // json
+		'NumResults'    => 'Int',
+	);
+
+	private static $has_one = array(
+		'Member'        => 'Member',
+		'ParentSearch'  => 'SearchLog', // used in constructing a search breadcrumb
+	);
+
+
+	/**
+	 * Generate the title if needed
+	 */
+	protected function onBeforeWrite()
+	{
+		parent::onBeforeWrite();
+		if (!$this->Title) {
+			$this->Title = empty($this->Query) ? "Search" : "Search: {$this->Query}";
+		}
+	}
+
+
+	/**
+	 * @return ArrayList
+	 */
+	public function getBreadcrumbs()
+	{
+		$out    = new ArrayList();
+		$cur    = $this;
+
+		while ($cur && $cur->exists()) {
+			$out->unshift($cur);
+			$cur = $cur->ParentSearchID > 0 ? $cur->ParentSearch() : null;
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getFiltersArray()
+	{
+		return $this->Filters ? json_decode($this->Filters, true) : array();
+	}
 }

code/ShopSearch.php

Indentation +356 added lines, -356 removed lines

@@ -1,383 +1,383 @@
 <?php
 /**
- * Fulltext search index for shop buyables
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 08.29.2013
- * @package shop_search
- */
+	 * Fulltext search index for shop buyables
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 08.29.2013
+	 * @package shop_search
+	 */
 class ShopSearch extends Object
 {
-    const FACET_TYPE_LINK       = 'link';
-    const FACET_TYPE_CHECKBOX   = 'checkbox';
-    const FACET_TYPE_RANGE      = 'range';
+	const FACET_TYPE_LINK       = 'link';
+	const FACET_TYPE_CHECKBOX   = 'checkbox';
+	const FACET_TYPE_RANGE      = 'range';
 
-    /** @var string - class name of adapter class to use */
-    private static $adapter_class = 'ShopSearchSimple';
+	/** @var string - class name of adapter class to use */
+	private static $adapter_class = 'ShopSearchSimple';
 
-    /** @var array - these classes will be added to the index - e.g. Category, Page, etc. */
-    private static $searchable = array();
+	/** @var array - these classes will be added to the index - e.g. Category, Page, etc. */
+	private static $searchable = array();
 
-    /** @var bool - if true, all buyable models will be added to the index automatically  */
-    private static $buyables_are_searchable = true;
+	/** @var bool - if true, all buyable models will be added to the index automatically  */
+	private static $buyables_are_searchable = true;
 
-    /** @var int - size of paging in the search */
-    private static $page_size = 10;
+	/** @var int - size of paging in the search */
+	private static $page_size = 10;
 
-    /** @var bool */
-    private static $suggest_enabled = true;
+	/** @var bool */
+	private static $suggest_enabled = true;
 
-    /** @var int - how many suggestions to provide */
-    private static $suggest_limit = 5;
+	/** @var int - how many suggestions to provide */
+	private static $suggest_limit = 5;
 
-    /** @var bool */
-    private static $search_as_you_type_enabled = true;
+	/** @var bool */
+	private static $search_as_you_type_enabled = true;
 
-    /** @var int - how may sayt (search-as-you-type) entries to provide */
-    private static $sayt_limit = 5;
+	/** @var int - how may sayt (search-as-you-type) entries to provide */
+	private static $sayt_limit = 5;
 
-    /** @var bool - automatically create facets for static attributes */
-    private static $auto_facet_attributes = false;
+	/** @var bool - automatically create facets for static attributes */
+	private static $auto_facet_attributes = false;
 
-    /** @var string - optionally, a different template to run ajax results through (sans-Page.ss) */
-    private static $ajax_results_template = '';
+	/** @var string - optionally, a different template to run ajax results through (sans-Page.ss) */
+	private static $ajax_results_template = '';
 
-    /** @var string - these allow you to use different querystring params in you need to */
-    private static $qs_query         = 'q';
-    private static $qs_filters       = 'f';
-    private static $qs_parent_search = '__ps';
-    private static $qs_title         = '__t';
-    private static $qs_source        = '__src'; // used to log searches from search-as-you-type
-    private static $qs_sort          = 'sort';
+	/** @var string - these allow you to use different querystring params in you need to */
+	private static $qs_query         = 'q';
+	private static $qs_filters       = 'f';
+	private static $qs_parent_search = '__ps';
+	private static $qs_title         = '__t';
+	private static $qs_source        = '__src'; // used to log searches from search-as-you-type
+	private static $qs_sort          = 'sort';
 
-    /** @var array - I'm leaving this particularly bare b/c with config merging it's a pain to remove items */
-    private static $sort_options = array(
-        'score desc'            => 'Relevance',
+	/** @var array - I'm leaving this particularly bare b/c with config merging it's a pain to remove items */
+	private static $sort_options = array(
+		'score desc'            => 'Relevance',
 //		'SiteTree_Title asc'    => 'Alphabetical (A-Z)',
 //		'SiteTree_Title dsc'    => 'Alphabetical (Z-A)',
-    );
-
-    /**
-     * @var array - default search facets (price, category, etc)
-     *   Key    field name - e.g. Price - can be a VirtualFieldIndex field
-     *   Value  facet label - e.g. Search By Category - if the value is a relation or returns an array or
-     *          list all values will be faceted individually
-     *          NOTE: this can also be another array with keys: Label, Type, and Values (for checkbox only)
-     */
-    private static $facets = array();
-
-    /** @var array - field definition for Solr only */
-    private static $solr_fulltext_fields = array();
-
-    /** @var array - field definition for Solr only */
-    private static $solr_filter_fields = array();
-
-    /** @var string - if present, will create a copy of SiteTree_Title that's suited for alpha sorting */
-    private static $solr_title_sort_field = '';
-
-    /**
-     * @var string - If present, everything matching the following regex will be removed from
-     *               keyword search queries before passing to the search adapter.
-     */
-    private static $keyword_filter_regex = '/[^a-zA-Z0-9\s\-]/';
-
-
-    /**
-     * @return array
-     */
-    public static function get_searchable_classes()
-    {
-        // First get any explicitly declared searchable classes
-        $searchable = Config::inst()->get('ShopSearch', 'searchable');
-        if (is_string($searchable) && strlen($searchable) > 0) {
-            $searchable = array($searchable);
-        } elseif (!is_array($searchable)) {
-            $searchable = array();
-        }
-
-        // Add in buyables automatically if asked
-        if (Config::inst()->get('ShopSearch', 'buyables_are_searchable')) {
-            $buyables = SS_ClassLoader::instance()->getManifest()->getImplementorsOf('Buyable');
-            if (is_array($buyables) && count($buyables) > 0) {
-                foreach ($buyables as $c) {
-                    $searchable[] = $c;
-                }
-            }
-        }
-
-        return array_unique($searchable);
-    }
-
-    /**
-     * Returns an array of categories suitable for a dropdown menu
-     * TODO: cache this
-     *
-     * @param int $parentID [optional]
-     * @param string $prefix [optional]
-     * @param int $maxDepth [optional]
-     * @return array
-     * @static
-     */
-    public static function get_category_hierarchy($parentID = 0, $prefix = '', $maxDepth = 999)
-    {
-        $out = array();
-        $cats = ProductCategory::get()
-            ->filter(array(
-                'ParentID'      => $parentID,
-                'ShowInMenus'   => 1,
-            ))
-            ->sort('Sort');
-
-        // If there is a single parent category (usually "Products" or something), we
-        // probably don't want that in the hierarchy.
-        if ($parentID == 0 && $cats->count() == 1) {
-            return self::get_category_hierarchy($cats->first()->ID, $prefix, $maxDepth);
-        }
-
-        foreach ($cats as $cat) {
-            $out[$cat->ID] = $prefix . $cat->Title;
-            if ($maxDepth > 1) {
-                $out += self::get_category_hierarchy($cat->ID, $prefix . $cat->Title . ' > ', $maxDepth - 1);
-            }
-        }
-
-        return $out;
-    }
-
-    /**
-     * @return ShopSearchAdapter
-     */
-    public static function adapter()
-    {
-        $adapterClass = Config::inst()->get('ShopSearch', 'adapter_class');
-        return Injector::inst()->get($adapterClass);
-    }
-
-    /**
-     * @return ShopSearch
-     */
-    public static function inst()
-    {
-        return Injector::inst()->get('ShopSearch');
-    }
-
-    /**
-     * The result will contain at least the following:
-     *      Matches - SS_List of results
-     *      TotalMatches - total # of results, unlimited
-     *      Query - query string
-     * Also saves a log record.
-     *
-     * @param array $vars
-     * @param bool $logSearch [optional]
-     * @param bool $useFacets [optional]
-     * @param int $start [optional]
-     * @param int $limit [optional]
-     * @return ArrayData
-     */
-    public function search(array $vars, $logSearch=true, $useFacets=true, $start=-1, $limit=-1)
-    {
-        $qs_q   = $this->config()->get('qs_query');
-        $qs_f   = $this->config()->get('qs_filters');
-        $qs_ps  = $this->config()->get('qs_parent_search');
-        $qs_t   = $this->config()->get('qs_title');
-        $qs_sort= $this->config()->get('qs_sort');
-        if ($limit < 0) {
-            $limit  = $this->config()->get('page_size');
-        }
-        if ($start < 0) {
-            $start  = !empty($vars['start']) ? (int)$vars['start'] : 0;
-        } // as far as i can see, fulltextsearch hard codes 'start'
-        $facets = $useFacets ? $this->config()->get('facets') : array();
-        if (!is_array($facets)) {
-            $facets = array();
-        }
-        if (empty($limit)) {
-            $limit = -1;
-        }
-
-        // figure out and scrub the sort
-        $sortOptions = $this->config()->get('sort_options');
-        $sort        = !empty($vars[$qs_sort]) ? $vars[$qs_sort] : '';
-        if (!isset($sortOptions[$sort])) {
-            $sort    = current(array_keys($sortOptions));
-        }
-
-        // figure out and scrub the filters
-        $filters  = !empty($vars[$qs_f]) ? FacetHelper::inst()->scrubFilters($vars[$qs_f]) : array();
-
-        // do the search
-        $keywords = !empty($vars[$qs_q]) ? $vars[$qs_q] : '';
-        if ($keywordRegex = $this->config()->get('keyword_filter_regex')) {
-            $keywords = preg_replace($keywordRegex, '', $keywords);
-        }
-        $results  = self::adapter()->searchFromVars($keywords, $filters, $facets, $start, $limit, $sort);
-
-        // massage the results a bit
-        if (!empty($keywords) && !$results->hasValue('Query')) {
-            $results->Query = $keywords;
-        }
-        if (!empty($filters) && !$results->hasValue('Filters')) {
-            $results->Filters = new ArrayData($filters);
-        }
-        if (!$results->hasValue('Sort')) {
-            $results->Sort = $sort;
-        }
-        if (!$results->hasValue('TotalMatches')) {
-            $results->TotalMatches = $results->Matches->hasMethod('getTotalItems')
-                ? $results->Matches->getTotalItems()
-                : $results->Matches->count();
-        }
-
-        // for some types of facets, update the state
-        if ($results->hasValue('Facets')) {
-            FacetHelper::inst()->transformHierarchies($results->Facets);
-            FacetHelper::inst()->updateFacetState($results->Facets, $filters);
-        }
-
-        // make a hash of the search so we can know if we've already logged it this session
-        $loggedFilters = !empty($filters) ? json_encode($filters) : null;
-        $loggedQuery   = strtolower($results->Query);
+	);
+
+	/**
+	 * @var array - default search facets (price, category, etc)
+	 *   Key    field name - e.g. Price - can be a VirtualFieldIndex field
+	 *   Value  facet label - e.g. Search By Category - if the value is a relation or returns an array or
+	 *          list all values will be faceted individually
+	 *          NOTE: this can also be another array with keys: Label, Type, and Values (for checkbox only)
+	 */
+	private static $facets = array();
+
+	/** @var array - field definition for Solr only */
+	private static $solr_fulltext_fields = array();
+
+	/** @var array - field definition for Solr only */
+	private static $solr_filter_fields = array();
+
+	/** @var string - if present, will create a copy of SiteTree_Title that's suited for alpha sorting */
+	private static $solr_title_sort_field = '';
+
+	/**
+	 * @var string - If present, everything matching the following regex will be removed from
+	 *               keyword search queries before passing to the search adapter.
+	 */
+	private static $keyword_filter_regex = '/[^a-zA-Z0-9\s\-]/';
+
+
+	/**
+	 * @return array
+	 */
+	public static function get_searchable_classes()
+	{
+		// First get any explicitly declared searchable classes
+		$searchable = Config::inst()->get('ShopSearch', 'searchable');
+		if (is_string($searchable) && strlen($searchable) > 0) {
+			$searchable = array($searchable);
+		} elseif (!is_array($searchable)) {
+			$searchable = array();
+		}
+
+		// Add in buyables automatically if asked
+		if (Config::inst()->get('ShopSearch', 'buyables_are_searchable')) {
+			$buyables = SS_ClassLoader::instance()->getManifest()->getImplementorsOf('Buyable');
+			if (is_array($buyables) && count($buyables) > 0) {
+				foreach ($buyables as $c) {
+					$searchable[] = $c;
+				}
+			}
+		}
+
+		return array_unique($searchable);
+	}
+
+	/**
+	 * Returns an array of categories suitable for a dropdown menu
+	 * TODO: cache this
+	 *
+	 * @param int $parentID [optional]
+	 * @param string $prefix [optional]
+	 * @param int $maxDepth [optional]
+	 * @return array
+	 * @static
+	 */
+	public static function get_category_hierarchy($parentID = 0, $prefix = '', $maxDepth = 999)
+	{
+		$out = array();
+		$cats = ProductCategory::get()
+			->filter(array(
+				'ParentID'      => $parentID,
+				'ShowInMenus'   => 1,
+			))
+			->sort('Sort');
+
+		// If there is a single parent category (usually "Products" or something), we
+		// probably don't want that in the hierarchy.
+		if ($parentID == 0 && $cats->count() == 1) {
+			return self::get_category_hierarchy($cats->first()->ID, $prefix, $maxDepth);
+		}
+
+		foreach ($cats as $cat) {
+			$out[$cat->ID] = $prefix . $cat->Title;
+			if ($maxDepth > 1) {
+				$out += self::get_category_hierarchy($cat->ID, $prefix . $cat->Title . ' > ', $maxDepth - 1);
+			}
+		}
+
+		return $out;
+	}
+
+	/**
+	 * @return ShopSearchAdapter
+	 */
+	public static function adapter()
+	{
+		$adapterClass = Config::inst()->get('ShopSearch', 'adapter_class');
+		return Injector::inst()->get($adapterClass);
+	}
+
+	/**
+	 * @return ShopSearch
+	 */
+	public static function inst()
+	{
+		return Injector::inst()->get('ShopSearch');
+	}
+
+	/**
+	 * The result will contain at least the following:
+	 *      Matches - SS_List of results
+	 *      TotalMatches - total # of results, unlimited
+	 *      Query - query string
+	 * Also saves a log record.
+	 *
+	 * @param array $vars
+	 * @param bool $logSearch [optional]
+	 * @param bool $useFacets [optional]
+	 * @param int $start [optional]
+	 * @param int $limit [optional]
+	 * @return ArrayData
+	 */
+	public function search(array $vars, $logSearch=true, $useFacets=true, $start=-1, $limit=-1)
+	{
+		$qs_q   = $this->config()->get('qs_query');
+		$qs_f   = $this->config()->get('qs_filters');
+		$qs_ps  = $this->config()->get('qs_parent_search');
+		$qs_t   = $this->config()->get('qs_title');
+		$qs_sort= $this->config()->get('qs_sort');
+		if ($limit < 0) {
+			$limit  = $this->config()->get('page_size');
+		}
+		if ($start < 0) {
+			$start  = !empty($vars['start']) ? (int)$vars['start'] : 0;
+		} // as far as i can see, fulltextsearch hard codes 'start'
+		$facets = $useFacets ? $this->config()->get('facets') : array();
+		if (!is_array($facets)) {
+			$facets = array();
+		}
+		if (empty($limit)) {
+			$limit = -1;
+		}
+
+		// figure out and scrub the sort
+		$sortOptions = $this->config()->get('sort_options');
+		$sort        = !empty($vars[$qs_sort]) ? $vars[$qs_sort] : '';
+		if (!isset($sortOptions[$sort])) {
+			$sort    = current(array_keys($sortOptions));
+		}
+
+		// figure out and scrub the filters
+		$filters  = !empty($vars[$qs_f]) ? FacetHelper::inst()->scrubFilters($vars[$qs_f]) : array();
+
+		// do the search
+		$keywords = !empty($vars[$qs_q]) ? $vars[$qs_q] : '';
+		if ($keywordRegex = $this->config()->get('keyword_filter_regex')) {
+			$keywords = preg_replace($keywordRegex, '', $keywords);
+		}
+		$results  = self::adapter()->searchFromVars($keywords, $filters, $facets, $start, $limit, $sort);
+
+		// massage the results a bit
+		if (!empty($keywords) && !$results->hasValue('Query')) {
+			$results->Query = $keywords;
+		}
+		if (!empty($filters) && !$results->hasValue('Filters')) {
+			$results->Filters = new ArrayData($filters);
+		}
+		if (!$results->hasValue('Sort')) {
+			$results->Sort = $sort;
+		}
+		if (!$results->hasValue('TotalMatches')) {
+			$results->TotalMatches = $results->Matches->hasMethod('getTotalItems')
+				? $results->Matches->getTotalItems()
+				: $results->Matches->count();
+		}
+
+		// for some types of facets, update the state
+		if ($results->hasValue('Facets')) {
+			FacetHelper::inst()->transformHierarchies($results->Facets);
+			FacetHelper::inst()->updateFacetState($results->Facets, $filters);
+		}
+
+		// make a hash of the search so we can know if we've already logged it this session
+		$loggedFilters = !empty($filters) ? json_encode($filters) : null;
+		$loggedQuery   = strtolower($results->Query);
 //		$searchHash    = md5($loggedFilters . $loggedQuery);
 //		$sessSearches  = Session::get('loggedSearches');
 //		if (!is_array($sessSearches)) $sessSearches = array();
 //		Debug::dump($searchHash, $sessSearches);
 
-        // save the log record
-        if ($start == 0 && $logSearch && (!empty($keywords) || !empty($filters))) { // && !in_array($searchHash, $sessSearches)) {
-            $log = SearchLog::create(array(
-                'Query'         => $loggedQuery,
-                'Title'         => !empty($vars[$qs_t]) ? $vars[$qs_t] : '',
-                'Link'          => Controller::curr()->getRequest()->getURL(true), // I'm not 100% happy with this, but can't think of a better way
-                'NumResults'    => $results->TotalMatches,
-                'MemberID'      => Member::currentUserID(),
-                'Filters'       => $loggedFilters,
-                'ParentSearchID'=> !empty($vars[$qs_ps]) ? $vars[$qs_ps] : 0,
-            ));
-            $log->write();
-            $results->SearchLogID = $log->ID;
-            $results->SearchBreadcrumbs = $log->getBreadcrumbs();
+		// save the log record
+		if ($start == 0 && $logSearch && (!empty($keywords) || !empty($filters))) { // && !in_array($searchHash, $sessSearches)) {
+			$log = SearchLog::create(array(
+				'Query'         => $loggedQuery,
+				'Title'         => !empty($vars[$qs_t]) ? $vars[$qs_t] : '',
+				'Link'          => Controller::curr()->getRequest()->getURL(true), // I'm not 100% happy with this, but can't think of a better way
+				'NumResults'    => $results->TotalMatches,
+				'MemberID'      => Member::currentUserID(),
+				'Filters'       => $loggedFilters,
+				'ParentSearchID'=> !empty($vars[$qs_ps]) ? $vars[$qs_ps] : 0,
+			));
+			$log->write();
+			$results->SearchLogID = $log->ID;
+			$results->SearchBreadcrumbs = $log->getBreadcrumbs();
 
 //			$sessSearches[] = $searchHash;
 //			Session::set('loggedSearches', $sessSearches);
-        }
-
-        return $results;
-    }
-
-    /**
-     * @param string $str
-     * @return SS_Query
-     */
-    public function getSuggestQuery($str='')
-    {
-        $hasResults = 'CASE WHEN max("SearchLog"."NumResults") > 0 THEN 1 ELSE 0 END';
-        $searchCount = 'count(distinct "SearchLog"."ID")';
-        $q = new SQLQuery();
-        $q = $q->setSelect('"SearchLog"."Query"')
-            // TODO: what to do with filter?
-            ->selectField($searchCount, 'SearchCount')
-            ->selectField('max("SearchLog"."Created")', 'LastSearch')
-            ->selectField('max("SearchLog"."NumResults")', 'NumResults')
-            ->selectField($hasResults, 'HasResults')
-            ->setFrom('"SearchLog"')
-            ->setGroupBy('"SearchLog"."Query"')
-            ->setOrderBy(array(
-                "$hasResults DESC",
-                "$searchCount DESC"
-            ))
-            ->setLimit(Config::inst()->get('ShopSearch', 'suggest_limit'))
-        ;
-
-        if (strlen($str) > 0) {
-            $q = $q->addWhere(sprintf('"SearchLog"."Query" LIKE \'%%%s%%\'', Convert::raw2sql($str)));
-        }
-
-        return $q;
-    }
-
-
-    /**
-     * @param string $str
-     * @return array
-     */
-    public function suggest($str='')
-    {
-        $adapter = self::adapter();
-        if ($adapter->hasMethod('suggest')) {
-            return $adapter->suggest($str);
-        } else {
-            return $this->getSuggestQuery($str)->execute()->column('Query');
-        }
-    }
-
-
-    /**
-     * Returns an array that can be made into json and passed to the controller
-     * containing both term suggestions and a few product matches.
-     *
-     * @param array $searchVars
-     * @return array
-     */
-    public function suggestWithResults(array $searchVars)
-    {
-        $qs_q       = $this->config()->get('qs_query');
-        $qs_f       = $this->config()->get('qs_filters');
-        $keywords   = !empty($searchVars[$qs_q]) ? $searchVars[$qs_q] : '';
-        $filters    = !empty($searchVars[$qs_f]) ? $searchVars[$qs_f] : array();
-
-        $adapter = self::adapter();
-
-        // get suggestions and product list from the adapter
-        if ($adapter->hasMethod('suggestWithResults')) {
-            $results = $adapter->suggestWithResults($keywords, $filters);
-        } else {
-            $limit      = (int)ShopSearch::config()->sayt_limit;
-            $search     = self::adapter()->searchFromVars($keywords, $filters, array(), 0, $limit, 'Popularity DESC');
-            //$search     = ShopSearch::inst()->search($searchVars, false, false, 0, $limit);
-
-            $results = array(
-                'products'      => $search->Matches,
-                'suggestions'   => $this->suggest($keywords),
-            );
-        }
-
-        // the adapter just gave us a list of products, which we need to process a little further
-        if (!empty($results['products'])) {
-            // this gets encoded into the product links
-            $searchVars['total'] = $results['products']->hasMethod('getTotalItems')
-                ? $results['products']->getTotalItems()
-                : $results['products']->count();
-
-            $products   = array();
-            foreach ($results['products'] as $prod) {
-                if (!$prod || !$prod->exists()) {
-                    continue;
-                }
-                $img = $prod->hasMethod('ProductImage') ? $prod->ProductImage() : $prod->Image();
-                $thumb = ($img && $img->exists()) ? $img->getThumbnail() : null;
-
-                $json = array(
-                    'link'  => $prod->Link() . '?' . ShopSearch::config()->qs_source . '=' . urlencode(base64_encode(json_encode($searchVars))),
-                    'title' => $prod->Title,
-                    'desc'  => $prod->obj('Content')->Summary(),
-                    'thumb' => $thumb ? $thumb->Link() : '',
-                    'price' => $prod->obj('Price')->Nice(),
-                );
-
-                if ($prod->hasExtension('HasPromotionalPricing') && $prod->hasValidPromotion()) {
-                    $json['original_price'] = $prod->getOriginalPrice()->Nice();
-                }
-
-                $products[] = $json;
-            }
-
-            // replace the list of product objects with json
-            $results['products'] = $products;
-        }
-
-        $this->extend('updateSuggestWithResults', $results, $keywords, $filters);
-
-        return $results;
-    }
+		}
+
+		return $results;
+	}
+
+	/**
+	 * @param string $str
+	 * @return SS_Query
+	 */
+	public function getSuggestQuery($str='')
+	{
+		$hasResults = 'CASE WHEN max("SearchLog"."NumResults") > 0 THEN 1 ELSE 0 END';
+		$searchCount = 'count(distinct "SearchLog"."ID")';
+		$q = new SQLQuery();
+		$q = $q->setSelect('"SearchLog"."Query"')
+			// TODO: what to do with filter?
+			->selectField($searchCount, 'SearchCount')
+			->selectField('max("SearchLog"."Created")', 'LastSearch')
+			->selectField('max("SearchLog"."NumResults")', 'NumResults')
+			->selectField($hasResults, 'HasResults')
+			->setFrom('"SearchLog"')
+			->setGroupBy('"SearchLog"."Query"')
+			->setOrderBy(array(
+				"$hasResults DESC",
+				"$searchCount DESC"
+			))
+			->setLimit(Config::inst()->get('ShopSearch', 'suggest_limit'))
+		;
+
+		if (strlen($str) > 0) {
+			$q = $q->addWhere(sprintf('"SearchLog"."Query" LIKE \'%%%s%%\'', Convert::raw2sql($str)));
+		}
+
+		return $q;
+	}
+
+
+	/**
+	 * @param string $str
+	 * @return array
+	 */
+	public function suggest($str='')
+	{
+		$adapter = self::adapter();
+		if ($adapter->hasMethod('suggest')) {
+			return $adapter->suggest($str);
+		} else {
+			return $this->getSuggestQuery($str)->execute()->column('Query');
+		}
+	}
+
+
+	/**
+	 * Returns an array that can be made into json and passed to the controller
+	 * containing both term suggestions and a few product matches.
+	 *
+	 * @param array $searchVars
+	 * @return array
+	 */
+	public function suggestWithResults(array $searchVars)
+	{
+		$qs_q       = $this->config()->get('qs_query');
+		$qs_f       = $this->config()->get('qs_filters');
+		$keywords   = !empty($searchVars[$qs_q]) ? $searchVars[$qs_q] : '';
+		$filters    = !empty($searchVars[$qs_f]) ? $searchVars[$qs_f] : array();
+
+		$adapter = self::adapter();
+
+		// get suggestions and product list from the adapter
+		if ($adapter->hasMethod('suggestWithResults')) {
+			$results = $adapter->suggestWithResults($keywords, $filters);
+		} else {
+			$limit      = (int)ShopSearch::config()->sayt_limit;
+			$search     = self::adapter()->searchFromVars($keywords, $filters, array(), 0, $limit, 'Popularity DESC');
+			//$search     = ShopSearch::inst()->search($searchVars, false, false, 0, $limit);
+
+			$results = array(
+				'products'      => $search->Matches,
+				'suggestions'   => $this->suggest($keywords),
+			);
+		}
+
+		// the adapter just gave us a list of products, which we need to process a little further
+		if (!empty($results['products'])) {
+			// this gets encoded into the product links
+			$searchVars['total'] = $results['products']->hasMethod('getTotalItems')
+				? $results['products']->getTotalItems()
+				: $results['products']->count();
+
+			$products   = array();
+			foreach ($results['products'] as $prod) {
+				if (!$prod || !$prod->exists()) {
+					continue;
+				}
+				$img = $prod->hasMethod('ProductImage') ? $prod->ProductImage() : $prod->Image();
+				$thumb = ($img && $img->exists()) ? $img->getThumbnail() : null;
+
+				$json = array(
+					'link'  => $prod->Link() . '?' . ShopSearch::config()->qs_source . '=' . urlencode(base64_encode(json_encode($searchVars))),
+					'title' => $prod->Title,
+					'desc'  => $prod->obj('Content')->Summary(),
+					'thumb' => $thumb ? $thumb->Link() : '',
+					'price' => $prod->obj('Price')->Nice(),
+				);
+
+				if ($prod->hasExtension('HasPromotionalPricing') && $prod->hasValidPromotion()) {
+					$json['original_price'] = $prod->getOriginalPrice()->Nice();
+				}
+
+				$products[] = $json;
+			}
+
+			// replace the list of product objects with json
+			$results['products'] = $products;
+		}
+
+		$this->extend('updateSuggestWithResults', $results, $keywords, $filters);
+
+		return $results;
+	}
 }

code/ShopSearchAdapter.php

Indentation +16 added lines, -16 removed lines

@@ -1,21 +1,21 @@
 <?php
 /**
- * Interface for shop search drivers.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 09.03.2013
- * @package shop_search
- */
+	 * Interface for shop search drivers.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 09.03.2013
+	 * @package shop_search
+	 */
 interface ShopSearchAdapter
 {
-    /**
-     * @param string $keywords
-     * @param array $filters [optional]
-     * @param array $facetSpec [optional]
-     * @param int $start [optional]
-     * @param int $limit [optional]
-     * @param string $sort [optional]
-     * @return ArrayData - must contain at least 'Matches' with an list of data objects that match the search
-     */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
+	/**
+	 * @param string $keywords
+	 * @param array $filters [optional]
+	 * @param array $facetSpec [optional]
+	 * @param int $start [optional]
+	 * @param int $limit [optional]
+	 * @param string $sort [optional]
+	 * @return ArrayData - must contain at least 'Matches' with an list of data objects that match the search
+	 */
+	public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
 }

code/ShopSearchAjax.php

Indentation +25 added lines, -25 removed lines

@@ -1,30 +1,30 @@
 <?php
 /**
- * Pending some changes introduced to the core shop module, this will supply
- * some standard, easily overridable ajax features.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 07.21.2014
- * @package shop_search
- */
+	 * Pending some changes introduced to the core shop module, this will supply
+	 * some standard, easily overridable ajax features.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 07.21.2014
+	 * @package shop_search
+	 */
 class ShopSearchAjax extends Extension
 {
-    /**
-     * @param SS_HTTPRequest $request
-     * @param SS_HTTPResponse $response
-     * @param ArrayData $results
-     * @param array $data
-     */
-    public function updateSearchResultsResponse(&$request, &$response, $results, $data)
-    {
-        if ($request->isAjax() && $this->owner->hasExtension('AjaxControllerExtension')) {
-            if (!$response) {
-                $response = $this->owner->getAjaxResponse();
-            }
-            $response->addRenderContext('RESULTS', $results);
-            $response->pushRegion('SearchResults', $results);
-            $response->pushRegion('SearchHeader', $results);
-            $response->triggerEvent('searchresults');
-        }
-    }
+	/**
+	 * @param SS_HTTPRequest $request
+	 * @param SS_HTTPResponse $response
+	 * @param ArrayData $results
+	 * @param array $data
+	 */
+	public function updateSearchResultsResponse(&$request, &$response, $results, $data)
+	{
+		if ($request->isAjax() && $this->owner->hasExtension('AjaxControllerExtension')) {
+			if (!$response) {
+				$response = $this->owner->getAjaxResponse();
+			}
+			$response->addRenderContext('RESULTS', $results);
+			$response->pushRegion('SearchResults', $results);
+			$response->pushRegion('SearchHeader', $results);
+			$response->triggerEvent('searchresults');
+		}
+	}
 }

code/ShopSearchControllerExtension.php

Indentation +76 added lines, -76 removed lines

@@ -1,92 +1,92 @@
 <?php
 /**
- * Adds SearchForm and results methods to the controller.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 08.29.2013
- * @package shop_search
- */
+	 * Adds SearchForm and results methods to the controller.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 08.29.2013
+	 * @package shop_search
+	 */
 class ShopSearchControllerExtension extends Extension
 {
-    private static $allowed_actions = array('SearchForm', 'results', 'search_suggest');
+	private static $allowed_actions = array('SearchForm', 'results', 'search_suggest');
 
-    /**
-     * @return ShopSearchForm
-     */
-    public function SearchForm()
-    {
-        return ShopSearchForm::create($this->owner, 'SearchForm', $this->owner->Link() . 'search-suggest');
-    }
+	/**
+	 * @return ShopSearchForm
+	 */
+	public function SearchForm()
+	{
+		return ShopSearchForm::create($this->owner, 'SearchForm', $this->owner->Link() . 'search-suggest');
+	}
 
 
-    /**
-     * @param SS_HTTPRequest $req
-     * @return string
-     */
-    public function search_suggest(SS_HTTPRequest $req)
-    {
-        /** @var SS_HTTPResponse $response */
-        $response    = $this->owner->getResponse();
-        $callback    = $req->requestVar('callback');
+	/**
+	 * @param SS_HTTPRequest $req
+	 * @return string
+	 */
+	public function search_suggest(SS_HTTPRequest $req)
+	{
+		/** @var SS_HTTPResponse $response */
+		$response    = $this->owner->getResponse();
+		$callback    = $req->requestVar('callback');
 
-        // convert the search results into usable json for search-as-you-type
-        if (ShopSearch::config()->search_as_you_type_enabled) {
-            $searchVars = $req->requestVars();
-            $searchVars[ ShopSearch::config()->qs_query ] = $searchVars['term'];
-            unset($searchVars['term']);
-            $results = ShopSearch::inst()->suggestWithResults($searchVars);
-        } else {
-            $results = array(
-                'suggestions'   => ShopSearch::inst()->suggest($req->requestVar('term')),
-            );
-        }
+		// convert the search results into usable json for search-as-you-type
+		if (ShopSearch::config()->search_as_you_type_enabled) {
+			$searchVars = $req->requestVars();
+			$searchVars[ ShopSearch::config()->qs_query ] = $searchVars['term'];
+			unset($searchVars['term']);
+			$results = ShopSearch::inst()->suggestWithResults($searchVars);
+		} else {
+			$results = array(
+				'suggestions'   => ShopSearch::inst()->suggest($req->requestVar('term')),
+			);
+		}
 
-        if ($callback) {
-            $response->addHeader('Content-type', 'application/javascript');
-            $response->setBody($callback . '(' . json_encode($results) . ');');
-        } else {
-            $response->addHeader('Content-type', 'application/json');
-            $response->setBody(json_encode($results));
-        }
-        return $response;
-    }
+		if ($callback) {
+			$response->addHeader('Content-type', 'application/javascript');
+			$response->setBody($callback . '(' . json_encode($results) . ');');
+		} else {
+			$response->addHeader('Content-type', 'application/json');
+			$response->setBody(json_encode($results));
+		}
+		return $response;
+	}
 
 
-    /**
-     * If there is a search encoded in the link, go ahead and log it.
-     * This happens when you click through on a search suggestion
-     */
-    public function onAfterInit()
-    {
-        $req = $this->owner->getRequest();
-        $src = $req->requestVar(Config::inst()->get('ShopSearch', 'qs_source'));
-        if ($src) {
-            $qs_q   = Config::inst()->get('ShopSearch', 'qs_query');
-            $qs_f   = Config::inst()->get('ShopSearch', 'qs_filters');
-            $vars   = json_decode(base64_decode($src), true);
+	/**
+	 * If there is a search encoded in the link, go ahead and log it.
+	 * This happens when you click through on a search suggestion
+	 */
+	public function onAfterInit()
+	{
+		$req = $this->owner->getRequest();
+		$src = $req->requestVar(Config::inst()->get('ShopSearch', 'qs_source'));
+		if ($src) {
+			$qs_q   = Config::inst()->get('ShopSearch', 'qs_query');
+			$qs_f   = Config::inst()->get('ShopSearch', 'qs_filters');
+			$vars   = json_decode(base64_decode($src), true);
 
-            // log the search
-            $log = SearchLog::create(array(
-                'Query'         => strtolower($vars[$qs_q]),
-                'Link'          => $req->getURL(false), // These searches will never have child searches, but this will allow us to know what they clicked
-                'NumResults'    => $vars['total'],
-                'MemberID'      => Member::currentUserID(),
-                'Filters'       => !empty($vars[$qs_f]) ? json_encode($vars[$qs_f]) : null,
-            ));
-            $log->write();
+			// log the search
+			$log = SearchLog::create(array(
+				'Query'         => strtolower($vars[$qs_q]),
+				'Link'          => $req->getURL(false), // These searches will never have child searches, but this will allow us to know what they clicked
+				'NumResults'    => $vars['total'],
+				'MemberID'      => Member::currentUserID(),
+				'Filters'       => !empty($vars[$qs_f]) ? json_encode($vars[$qs_f]) : null,
+			));
+			$log->write();
 
-            // redirect to the clean page
-            $this->owner->redirect($req->getURL(false));
-        }
-    }
+			// redirect to the clean page
+			$this->owner->redirect($req->getURL(false));
+		}
+	}
 
 
-    /**
-     * @param ArrayData $results
-     * @param array     $data
-     * @return string
-     */
-    protected function generateLongTitle(ArrayData $results, array $data)
-    {
-    }
+	/**
+	 * @param ArrayData $results
+	 * @param array     $data
+	 * @return string
+	 */
+	protected function generateLongTitle(ArrayData $results, array $data)
+	{
+	}
 }

code/ShopSearchForm.php

Indentation +147 added lines, -147 removed lines

@@ -1,152 +1,152 @@
 <?php
 /**
- * Form object for shop search.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 09.23.2013
- * @package shop_search
- */
+	 * Form object for shop search.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 09.23.2013
+	 * @package shop_search
+	 */
 class ShopSearchForm extends Form
 {
-    /** @var bool - setting this to true will remove the category dropdwon from the form */
-    private static $disable_category_dropdown = false;
-
-    /** @var string - this probably ought to be overridden with a vfi or solr facet unless you're products are only in one category */
-    private static $category_field = 'f[ParentID]';
-
-    /** @var string - setting to 'NONE' will mean the category dropdwon will have no empty option */
-    private static $category_empty_string = 'All Products';
-
-    /** @var int - how deep to list the categories for the dropdown */
-    private static $category_max_depth = 10;
-
-
-    /**
-     * @param Controller $controller
-     * @param String     $method
-     * @param string     $suggestURL
-     */
-    public function __construct($controller, $method, $suggestURL = '')
-    {
-        $searchField = TextField::create('q', '');
-        $searchField->setAttribute('placeholder', _t('ShopSearch.SEARCH', 'Search'));
-        if ($suggestURL) {
-            $searchField->setAttribute('data-suggest-url', $suggestURL);
-        }
-
-        $fields = FieldList::create($searchField);
-        if (!self::config()->disable_category_dropdown) {
-            $cats     = ShopSearch::get_category_hierarchy(0, '', self::config()->category_max_depth);
-            $catField = DropdownField::create(self::get_category_field(), '', $cats, Session::get('LastSearchCatID'));
-
-            $emptyString = self::config()->category_empty_string;
-            if ($emptyString !== 'NONE') {
-                $catField->setEmptyString(_t('ShopSearch.'.$emptyString, $emptyString));
-            }
-
-            $fields->push($catField);
-        }
-
-        parent::__construct($controller, $method, $fields, FieldList::create(array(FormAction::create('results', _t('ShopSearch.GO', 'Go')))));
-
-        $this->setFormMethod('GET');
-        $this->disableSecurityToken();
-        if ($c = self::config()->css_classes) {
-            $this->addExtraClass($c);
-        }
-
-        Requirements::css(SHOP_SEARCH_FOLDER . '/css/ShopSearch.css');
-
-        if (Config::inst()->get('ShopSearch', 'suggest_enabled')) {
-            Requirements::javascript(THIRDPARTY_DIR . '/jquery-ui/jquery-ui.js');
-            Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
-            Requirements::javascript(SHOP_SEARCH_FOLDER . '/javascript/search.suggest.js');
-            Requirements::javascript(SHOP_SEARCH_FOLDER . '/javascript/search.js');
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function get_category_field()
-    {
-        return Config::inst()->get('ShopSearchForm', 'category_field');
-    }
-
-
-    /**
-     * @param array $data
-     * @return mixed
-     */
-    public function results(array $data)
-    {
-        // do the search
-        $results  = ShopSearch::inst()->search($data);
-        $request  = $this->controller->getRequest();
-        $baseLink = $request->getURL(false);
-
-        // if there was only one category filter, remember it for the category dropdown to retain it's value
-        if (!ShopSearchForm::config()->disable_category_dropdown) {
-            $qs_filters  = (string)Config::inst()->get('ShopSearch', 'qs_filters');
-            $categoryKey = (string)ShopSearchForm::config()->category_field;
-
-            if (preg_match('/\[(.+)\]/', $categoryKey, $matches)) {
-                // get right of the f[] around the actual key if present
-                $categoryKey = $matches[1];
-            }
-
-            if (!empty($data[$qs_filters][$categoryKey])) {
-                $categoryID = $data[$qs_filters][$categoryKey];
-                if (is_numeric($categoryID)) {
-                    // If it's set in the dropdown it will just be a number
-                    // If it's set from the checkboxes it will be something like LIST~1,2,3,4
-                    // We only want to remember the value in the former case
-                    Session::set('LastSearchCatID', $categoryID);
-                }
-            } else {
-                // If they unchecked every value, then clear the dropdown as well
-                Session::clear('LastSearchCatID');
-            }
-        }
-
-        // add links for any facets
-        if ($results->Facets && $results->Facets->count()) {
-            $qs_ps      = (string)Config::inst()->get('ShopSearch', 'qs_parent_search');
-            $baseParams = array_merge($data, array($qs_ps => $results->SearchLogID));
-            unset($baseParams['url']);
-            $results->Facets = FacetHelper::inst()->insertFacetLinks($results->Facets, $baseParams, $baseLink);
-        }
-
-        // add a dropdown for sorting
-        $qs_sort    = (string)Config::inst()->get('ShopSearch', 'qs_sort');
-        $options    = Config::inst()->get('ShopSearch', 'sort_options');
-        $sortParams = array_merge($data, array($qs_sort => 'NEWSORTVALUE'));
-        unset($sortParams['url']);
-        $results->SortControl = DropdownField::create($qs_sort, ShopSearch::config()->sort_label, $options, $results->Sort)
-            ->setAttribute('data-url', $baseLink . '?' . http_build_query($sortParams));
-
-        // a little more output management
-        $results->Title = "Search Results";
-        $results->Results = $results->Matches; // this makes us compatible with the default search template
-
-        // Give a hook for the parent controller to format the results, for example,
-        // interpreting filters in a specific way to affect the title or content
-        // when no results are returned. Since this is domain-specific we just leave
-        // it up to the host app.
-        if ($this->controller->hasMethod('onBeforeSearchDisplay')) {
-            $this->controller->onBeforeSearchDisplay($results);
-        }
-
-        // give a hook for processing ajax requests through a different template (i.e. for returning only fragments)
-        $tpl = Config::inst()->get('ShopSearch', 'ajax_results_template');
-        if (!empty($tpl) && Director::is_ajax()) {
-            return $this->controller->customise($results)->renderWith($tpl);
-        }
-
-        // Give a hook for modifying the search responses
-        $this->controller->extend('updateSearchResultsResponse', $request, $response, $results, $data);
-
-        return $response ?: $this->controller->customise($results)->renderWith(array('ShopSearch_results', 'Page_results', 'Page'));
-    }
+	/** @var bool - setting this to true will remove the category dropdwon from the form */
+	private static $disable_category_dropdown = false;
+
+	/** @var string - this probably ought to be overridden with a vfi or solr facet unless you're products are only in one category */
+	private static $category_field = 'f[ParentID]';
+
+	/** @var string - setting to 'NONE' will mean the category dropdwon will have no empty option */
+	private static $category_empty_string = 'All Products';
+
+	/** @var int - how deep to list the categories for the dropdown */
+	private static $category_max_depth = 10;
+
+
+	/**
+	 * @param Controller $controller
+	 * @param String     $method
+	 * @param string     $suggestURL
+	 */
+	public function __construct($controller, $method, $suggestURL = '')
+	{
+		$searchField = TextField::create('q', '');
+		$searchField->setAttribute('placeholder', _t('ShopSearch.SEARCH', 'Search'));
+		if ($suggestURL) {
+			$searchField->setAttribute('data-suggest-url', $suggestURL);
+		}
+
+		$fields = FieldList::create($searchField);
+		if (!self::config()->disable_category_dropdown) {
+			$cats     = ShopSearch::get_category_hierarchy(0, '', self::config()->category_max_depth);
+			$catField = DropdownField::create(self::get_category_field(), '', $cats, Session::get('LastSearchCatID'));
+
+			$emptyString = self::config()->category_empty_string;
+			if ($emptyString !== 'NONE') {
+				$catField->setEmptyString(_t('ShopSearch.'.$emptyString, $emptyString));
+			}
+
+			$fields->push($catField);
+		}
+
+		parent::__construct($controller, $method, $fields, FieldList::create(array(FormAction::create('results', _t('ShopSearch.GO', 'Go')))));
+
+		$this->setFormMethod('GET');
+		$this->disableSecurityToken();
+		if ($c = self::config()->css_classes) {
+			$this->addExtraClass($c);
+		}
+
+		Requirements::css(SHOP_SEARCH_FOLDER . '/css/ShopSearch.css');
+
+		if (Config::inst()->get('ShopSearch', 'suggest_enabled')) {
+			Requirements::javascript(THIRDPARTY_DIR . '/jquery-ui/jquery-ui.js');
+			Requirements::css(THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css');
+			Requirements::javascript(SHOP_SEARCH_FOLDER . '/javascript/search.suggest.js');
+			Requirements::javascript(SHOP_SEARCH_FOLDER . '/javascript/search.js');
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function get_category_field()
+	{
+		return Config::inst()->get('ShopSearchForm', 'category_field');
+	}
+
+
+	/**
+	 * @param array $data
+	 * @return mixed
+	 */
+	public function results(array $data)
+	{
+		// do the search
+		$results  = ShopSearch::inst()->search($data);
+		$request  = $this->controller->getRequest();
+		$baseLink = $request->getURL(false);
+
+		// if there was only one category filter, remember it for the category dropdown to retain it's value
+		if (!ShopSearchForm::config()->disable_category_dropdown) {
+			$qs_filters  = (string)Config::inst()->get('ShopSearch', 'qs_filters');
+			$categoryKey = (string)ShopSearchForm::config()->category_field;
+
+			if (preg_match('/\[(.+)\]/', $categoryKey, $matches)) {
+				// get right of the f[] around the actual key if present
+				$categoryKey = $matches[1];
+			}
+
+			if (!empty($data[$qs_filters][$categoryKey])) {
+				$categoryID = $data[$qs_filters][$categoryKey];
+				if (is_numeric($categoryID)) {
+					// If it's set in the dropdown it will just be a number
+					// If it's set from the checkboxes it will be something like LIST~1,2,3,4
+					// We only want to remember the value in the former case
+					Session::set('LastSearchCatID', $categoryID);
+				}
+			} else {
+				// If they unchecked every value, then clear the dropdown as well
+				Session::clear('LastSearchCatID');
+			}
+		}
+
+		// add links for any facets
+		if ($results->Facets && $results->Facets->count()) {
+			$qs_ps      = (string)Config::inst()->get('ShopSearch', 'qs_parent_search');
+			$baseParams = array_merge($data, array($qs_ps => $results->SearchLogID));
+			unset($baseParams['url']);
+			$results->Facets = FacetHelper::inst()->insertFacetLinks($results->Facets, $baseParams, $baseLink);
+		}
+
+		// add a dropdown for sorting
+		$qs_sort    = (string)Config::inst()->get('ShopSearch', 'qs_sort');
+		$options    = Config::inst()->get('ShopSearch', 'sort_options');
+		$sortParams = array_merge($data, array($qs_sort => 'NEWSORTVALUE'));
+		unset($sortParams['url']);
+		$results->SortControl = DropdownField::create($qs_sort, ShopSearch::config()->sort_label, $options, $results->Sort)
+			->setAttribute('data-url', $baseLink . '?' . http_build_query($sortParams));
+
+		// a little more output management
+		$results->Title = "Search Results";
+		$results->Results = $results->Matches; // this makes us compatible with the default search template
+
+		// Give a hook for the parent controller to format the results, for example,
+		// interpreting filters in a specific way to affect the title or content
+		// when no results are returned. Since this is domain-specific we just leave
+		// it up to the host app.
+		if ($this->controller->hasMethod('onBeforeSearchDisplay')) {
+			$this->controller->onBeforeSearchDisplay($results);
+		}
+
+		// give a hook for processing ajax requests through a different template (i.e. for returning only fragments)
+		$tpl = Config::inst()->get('ShopSearch', 'ajax_results_template');
+		if (!empty($tpl) && Director::is_ajax()) {
+			return $this->controller->customise($results)->renderWith($tpl);
+		}
+
+		// Give a hook for modifying the search responses
+		$this->controller->extend('updateSearchResultsResponse', $request, $response, $results, $data);
+
+		return $response ?: $this->controller->customise($results)->renderWith(array('ShopSearch_results', 'Page_results', 'Page'));
+	}
 }

code/adapters/ShopSearchMysql.php

Indentation +72 added lines, -72 removed lines

@@ -1,89 +1,89 @@
 <?php
 /**
- * Adapter that will use MySQL's full text search features.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 11.13.2013
- * @package shop_search
- * @subpackage adapters
- */
+	 * Adapter that will use MySQL's full text search features.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 11.13.2013
+	 * @package shop_search
+	 * @subpackage adapters
+	 */
 class ShopSearchMysql extends Object implements ShopSearchAdapter
 {
-    /**
-     * @param string $keywords
-     * @param array $filters [optional]
-     * @param array $facetSpec [optional]
-     * @param int $start [optional]
-     * @param int $limit [optional]
-     * @param string $sort [optional]
-     * @return ArrayData
-     */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
-    {
-        $searchable = ShopSearch::get_searchable_classes();
-        $matches = new ArrayList;
+	/**
+	 * @param string $keywords
+	 * @param array $filters [optional]
+	 * @param array $facetSpec [optional]
+	 * @param int $start [optional]
+	 * @param int $limit [optional]
+	 * @param string $sort [optional]
+	 * @return ArrayData
+	 */
+	public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
+	{
+		$searchable = ShopSearch::get_searchable_classes();
+		$matches = new ArrayList;
 
-        foreach ($searchable as $className) {
-            $list = DataObject::get($className);
+		foreach ($searchable as $className) {
+			$list = DataObject::get($className);
 
-            // get searchable fields
-            $keywordFields = $this->getSearchFields($className);
+			// get searchable fields
+			$keywordFields = $this->getSearchFields($className);
 
-            // build the filter
-            $filter = array();
+			// build the filter
+			$filter = array();
 
-            // Use parametrized query if SilverStripe >= 3.2
-            if (SHOP_SEARCH_IS_SS32) {
-                foreach ($keywordFields as $indexFields) {
-                    $filter[] = array("MATCH ($indexFields) AGAINST (?)" => $keywords);
-                }
-                $list = $list->whereAny($filter);
-            } else {
-                foreach ($keywordFields as $indexFields) {
-                    $filter[] = sprintf("MATCH ($indexFields) AGAINST ('%s')", Convert::raw2sql($keywords));
-                }
-                // join all the filters with an "OR" statement
-                $list = $list->where(implode(' OR ', $filter));
-            }
+			// Use parametrized query if SilverStripe >= 3.2
+			if (SHOP_SEARCH_IS_SS32) {
+				foreach ($keywordFields as $indexFields) {
+					$filter[] = array("MATCH ($indexFields) AGAINST (?)" => $keywords);
+				}
+				$list = $list->whereAny($filter);
+			} else {
+				foreach ($keywordFields as $indexFields) {
+					$filter[] = sprintf("MATCH ($indexFields) AGAINST ('%s')", Convert::raw2sql($keywords));
+				}
+				// join all the filters with an "OR" statement
+				$list = $list->where(implode(' OR ', $filter));
+			}
 
-            // add in any other filters
-            $list = FacetHelper::inst()->addFiltersToDataList($list, $filters);
+			// add in any other filters
+			$list = FacetHelper::inst()->addFiltersToDataList($list, $filters);
 
-            // add any matches to the big list
-            $matches->merge($list);
-        }
+			// add any matches to the big list
+			$matches->merge($list);
+		}
 
-        return new ArrayData(array(
-            'Matches'   => $matches,
-            'Facets'    => FacetHelper::inst()->buildFacets($matches, $facetSpec, (bool)Config::inst()->get('ShopSearch', 'auto_facet_attributes')),
-        ));
-    }
+		return new ArrayData(array(
+			'Matches'   => $matches,
+			'Facets'    => FacetHelper::inst()->buildFacets($matches, $facetSpec, (bool)Config::inst()->get('ShopSearch', 'auto_facet_attributes')),
+		));
+	}
 
 
-    /**
-     * @param $className
-     * @return array an array containing fields per index
-     * @throws Exception
-     */
-    protected function getSearchFields($className)
-    {
-        $indexes = Config::inst()->get($className, 'indexes');
+	/**
+	 * @param $className
+	 * @return array an array containing fields per index
+	 * @throws Exception
+	 */
+	protected function getSearchFields($className)
+	{
+		$indexes = Config::inst()->get($className, 'indexes');
 
-        $indexList = array();
-        foreach ($indexes as $name => $index) {
-            if (is_array($index)) {
-                if (!empty($index['type']) && $index['type'] == 'fulltext' && !empty($index['value'])) {
-                    $indexList[] = trim($index['value']);
-                }
-            } elseif (preg_match('/fulltext\((.+)\)/', $index, $m)) {
-                $indexList[] = trim($m[1]);
-            }
-        }
+		$indexList = array();
+		foreach ($indexes as $name => $index) {
+			if (is_array($index)) {
+				if (!empty($index['type']) && $index['type'] == 'fulltext' && !empty($index['value'])) {
+					$indexList[] = trim($index['value']);
+				}
+			} elseif (preg_match('/fulltext\((.+)\)/', $index, $m)) {
+				$indexList[] = trim($m[1]);
+			}
+		}
 
-        if (count($indexList) === 0) {
-            throw new Exception("Class $className does not appear to have any fulltext indexes");
-        }
+		if (count($indexList) === 0) {
+			throw new Exception("Class $className does not appear to have any fulltext indexes");
+		}
 
-        return $indexList;
-    }
+		return $indexList;
+	}
 }

code/adapters/ShopSearchSimple.php

Indentation +89 added lines, -89 removed lines

@@ -1,104 +1,104 @@
 <?php
 /**
- * VERY simple adapter to use DataList and :PartialMatch searches. Bare mininum
- * that will probably get terrible results but doesn't require any
- * additional setup.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 09.03.2013
- * @package shop_search
- */
+	 * VERY simple adapter to use DataList and :PartialMatch searches. Bare mininum
+	 * that will probably get terrible results but doesn't require any
+	 * additional setup.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 09.03.2013
+	 * @package shop_search
+	 */
 class ShopSearchSimple extends Object implements ShopSearchAdapter
 {
-    /**
-     * @param string $keywords
-     * @param array $filters [optional]
-     * @param array $facetSpec [optional]
-     * @param int $start [optional]
-     * @param int $limit [optional]
-     * @param string $sort [optional]
-     * @return ArrayData
-     */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
-    {
-        $searchable = ShopSearch::get_searchable_classes();
-        $matches = new ArrayList;
+	/**
+	 * @param string $keywords
+	 * @param array $filters [optional]
+	 * @param array $facetSpec [optional]
+	 * @param int $start [optional]
+	 * @param int $limit [optional]
+	 * @param string $sort [optional]
+	 * @return ArrayData
+	 */
+	public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
+	{
+		$searchable = ShopSearch::get_searchable_classes();
+		$matches = new ArrayList;
 
-        foreach ($searchable as $className) {
-            $list = DataObject::get($className);
+		foreach ($searchable as $className) {
+			$list = DataObject::get($className);
 
-            // get searchable fields
-            $keywordFields = $this->scaffoldSearchFields($className);
+			// get searchable fields
+			$keywordFields = $this->scaffoldSearchFields($className);
 
-            // convert that list into something we can pass to Datalist::filter
-            $keywordFilter = array();
-            if (!empty($keywords)) {
-                foreach ($keywordFields as $searchField) {
-                    $name = (strpos($searchField, ':') !== false) ? $searchField : "$searchField:PartialMatch";
-                    $keywordFilter[$name] = $keywords;
-                }
-            }
-            if (count($keywordFilter) > 0) {
-                $list = $list->filterAny($keywordFilter);
-            }
+			// convert that list into something we can pass to Datalist::filter
+			$keywordFilter = array();
+			if (!empty($keywords)) {
+				foreach ($keywordFields as $searchField) {
+					$name = (strpos($searchField, ':') !== false) ? $searchField : "$searchField:PartialMatch";
+					$keywordFilter[$name] = $keywords;
+				}
+			}
+			if (count($keywordFilter) > 0) {
+				$list = $list->filterAny($keywordFilter);
+			}
 
-            // add in any other filters
-            $list = FacetHelper::inst()->addFiltersToDataList($list, $filters);
+			// add in any other filters
+			$list = FacetHelper::inst()->addFiltersToDataList($list, $filters);
 
-            // add any matches to the big list
-            $matches->merge($list);
-        }
+			// add any matches to the big list
+			$matches->merge($list);
+		}
 
-        return new ArrayData(array(
-            'Matches'   => $matches,
-            'Facets'    => FacetHelper::inst()->buildFacets($matches, $facetSpec, (bool)Config::inst()->get('ShopSearch', 'auto_facet_attributes')),
-        ));
-    }
+		return new ArrayData(array(
+			'Matches'   => $matches,
+			'Facets'    => FacetHelper::inst()->buildFacets($matches, $facetSpec, (bool)Config::inst()->get('ShopSearch', 'auto_facet_attributes')),
+		));
+	}
 
 
-    /**
-     * This is verbatim copied from GridFieldAddExistingAutocompleter, with the exception
-     * that the default is 'PartialMatch' instead of 'StartsWith'
-     *
-     * @param String $dataClass - the class name
-     * @return Array|null - names of the searchable fields, with filters if appropriate
-     */
-    protected function scaffoldSearchFields($dataClass)
-    {
-        $obj = singleton($dataClass);
-        $fields = null;
-        if ($fieldSpecs = $obj->searchableFields()) {
-            $customSearchableFields = $obj->stat('searchable_fields');
-            foreach ($fieldSpecs as $name => $spec) {
-                if (is_array($spec) && array_key_exists('filter', $spec)) {
-                    // The searchableFields() spec defaults to PartialMatch,
-                    // so we need to check the original setting.
-                    // If the field is defined $searchable_fields = array('MyField'),
-                    // then default to StartsWith filter, which makes more sense in this context.
-                    if (!$customSearchableFields || array_search($name, $customSearchableFields)) {
-                        $filter = 'PartialMatch';
-                    } else {
-                        $filter = preg_replace('/Filter$/', '', $spec['filter']);
-                    }
+	/**
+	 * This is verbatim copied from GridFieldAddExistingAutocompleter, with the exception
+	 * that the default is 'PartialMatch' instead of 'StartsWith'
+	 *
+	 * @param String $dataClass - the class name
+	 * @return Array|null - names of the searchable fields, with filters if appropriate
+	 */
+	protected function scaffoldSearchFields($dataClass)
+	{
+		$obj = singleton($dataClass);
+		$fields = null;
+		if ($fieldSpecs = $obj->searchableFields()) {
+			$customSearchableFields = $obj->stat('searchable_fields');
+			foreach ($fieldSpecs as $name => $spec) {
+				if (is_array($spec) && array_key_exists('filter', $spec)) {
+					// The searchableFields() spec defaults to PartialMatch,
+					// so we need to check the original setting.
+					// If the field is defined $searchable_fields = array('MyField'),
+					// then default to StartsWith filter, which makes more sense in this context.
+					if (!$customSearchableFields || array_search($name, $customSearchableFields)) {
+						$filter = 'PartialMatch';
+					} else {
+						$filter = preg_replace('/Filter$/', '', $spec['filter']);
+					}
 
-                    if (class_exists($filter . 'Filter')) {
-                        $fields[] = "{$name}:{$filter}";
-                    } else {
-                        $fields[] = $name;
-                    }
-                } else {
-                    $fields[] = $name;
-                }
-            }
-        }
-        if (is_null($fields)) {
-            if ($obj->hasDatabaseField('Title')) {
-                $fields = array('Title');
-            } elseif ($obj->hasDatabaseField('Name')) {
-                $fields = array('Name');
-            }
-        }
+					if (class_exists($filter . 'Filter')) {
+						$fields[] = "{$name}:{$filter}";
+					} else {
+						$fields[] = $name;
+					}
+				} else {
+					$fields[] = $name;
+				}
+			}
+		}
+		if (is_null($fields)) {
+			if ($obj->hasDatabaseField('Title')) {
+				$fields = array('Title');
+			} elseif ($obj->hasDatabaseField('Name')) {
+				$fields = array('Name');
+			}
+		}
 
-        return $fields;
-    }
+		return $fields;
+	}
 }