markguinn / silverstripe-shop-search

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;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * @param string $sort [optional]
      * @return ArrayData
      */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
+    public function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = '')
     {
         $searchable = ShopSearch::get_searchable_classes();
         $matches = new ArrayList;

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;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * @param string $sort [optional]
      * @return ArrayData
      */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='')
+    public function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = '')
     {
         $searchable = ShopSearch::get_searchable_classes();
         $matches = new ArrayList;

code/adapters/ShopSearchSolr.php

Indentation +648 added lines, -648 removed lines

@@ -1,53 +1,53 @@ 
 <?php
 /**
- * Search driver for the fulltext module with solr backend.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 08.29.2013
- * @package shop_search
- */
+	 * Search driver for the fulltext module with solr backend.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 08.29.2013
+	 * @package shop_search
+	 */
 class ShopSearchSolr extends SolrIndex implements ShopSearchAdapter
 {
-    /** @var array - maps our names for fields to Solr's names (i.e. Title => SiteTree_Title) */
-    protected $fieldMap = array();
-
-    /**
-     * Sets up the index
-     */
-    public function init()
-    {
-        $searchables = ShopSearch::get_searchable_classes();
-
-        // Add each class to the index
-        foreach ($searchables as $class) {
-            $this->addClass($class);
-        }
-
-        // add the fields they've specifically asked for
-        $fields = $this->getFulltextSpec();
-        foreach ($fields as $def) {
-            $this->addFulltextField($def['field'], $def['type'], $def['params']);
-        }
-
-        // add the filters they've asked for
-        $filters = $this->getFilterSpec();
-        foreach ($filters as $filterName => $def) {
-            // NOTE: I'm pulling the guts out of this function so we can access Solr's full name
-            // for the field (SiteTree_Title for Title) and build the fieldMap in one step instead
-            // of two.
-            //$this->addFilterField($def['field'], $def['type'], $def['params']);
-            $singleFilter = $this->fieldData($def['field'], $def['type'], $def['params']);
-            $this->filterFields = array_merge($this->filterFields, $singleFilter);
-            foreach ($singleFilter as $solrName => $solrDef) {
-                if ($def['field'] == $solrDef['field']) {
-                    $this->fieldMap[$filterName] = $solrName;
-                }
-            }
-        }
+	/** @var array - maps our names for fields to Solr's names (i.e. Title => SiteTree_Title) */
+	protected $fieldMap = array();
+
+	/**
+	 * Sets up the index
+	 */
+	public function init()
+	{
+		$searchables = ShopSearch::get_searchable_classes();
+
+		// Add each class to the index
+		foreach ($searchables as $class) {
+			$this->addClass($class);
+		}
+
+		// add the fields they've specifically asked for
+		$fields = $this->getFulltextSpec();
+		foreach ($fields as $def) {
+			$this->addFulltextField($def['field'], $def['type'], $def['params']);
+		}
+
+		// add the filters they've asked for
+		$filters = $this->getFilterSpec();
+		foreach ($filters as $filterName => $def) {
+			// NOTE: I'm pulling the guts out of this function so we can access Solr's full name
+			// for the field (SiteTree_Title for Title) and build the fieldMap in one step instead
+			// of two.
+			//$this->addFilterField($def['field'], $def['type'], $def['params']);
+			$singleFilter = $this->fieldData($def['field'], $def['type'], $def['params']);
+			$this->filterFields = array_merge($this->filterFields, $singleFilter);
+			foreach ($singleFilter as $solrName => $solrDef) {
+				if ($def['field'] == $solrDef['field']) {
+					$this->fieldMap[$filterName] = $solrName;
+				}
+			}
+		}
 
 //		Debug::dump($this->filterFields);
 
-        // Add spellcheck fields
+		// Add spellcheck fields
 //		$spellFields = $cfg->get('ShopSearch', 'spellcheck_dictionary_source');
 //		if (empty($spellFields) || !is_array($spellFields)) {
 //			$spellFields = array();
@@ -61,11 +61,11 @@ 
 //			$this->addCopyField($f, '_spellcheckContent');
 //		}
 
-        // Technically, filter and sort fields are the same in Solr/Lucene
+		// Technically, filter and sort fields are the same in Solr/Lucene
 //		$this->addSortField('ViewCount');
 //		$this->addSortField('LastEdited', 'SSDatetime');
 
-        // Aggregate fields for spelling checks
+		// Aggregate fields for spelling checks
 //		$this->addCopyField('Title', 'spellcheckData');
 //		$this->addCopyField('Content', 'spellcheckData');
 
@@ -78,144 +78,144 @@ 
 //			)
 //		));
 
-        // I can't get this to work. Need a way to create the Category field that get used
+		// I can't get this to work. Need a way to create the Category field that get used
 //		$this->addFilterField('Category', 'Int');
 //		$this->addFilterField('Parent.ID');
 //		$this->addFilterField('ProductCategories.ID');
 //		$this->addCopyField('SiteTree_Parent_ID', 'Category');
 //		$this->addCopyField('Product_ProductCategories_ID', 'Category');
 
-        // These will be added in a pull request to shop module. If they're not present they'll be ignored
+		// These will be added in a pull request to shop module. If they're not present they'll be ignored
 //		$this->addFilterField('AllCategoryIDs', 'Int', array('multiValued' => 'true'));
 //		$this->addFilterField('AllRecursiveCategoryIDs', 'Int', array('multiValued' => 'true'));
 
-        // This will cause only live pages to be indexed. There are two ways to do
-        // this. See fulltextsearch/docs/en/index.md for more information.
-        // Not sure if this is really the way to go or not, but for now this is it.
-        $this->excludeVariantState(array('SearchVariantVersioned' => 'Stage'));
-    }
-
-
-    /**
-     * Transforms different formats of field list into something we can pass to solr
-     * @param array $in
-     * @return array
-     */
-    protected function scrubFieldList($in)
-    {
-        $out = array();
-        if (empty($in) || !is_array($in)) {
-            return $out;
-        }
-
-        foreach ($in as $name => $val) {
-            // supports an indexed array format of simple field names
-            if (is_numeric($name)) {
-                $name = $val;
-                $val = true;
-            }
-
-            // supports a boolean value meaning "use the default setup"
-            $params = !is_array($val) ? array() : array_slice($val, 0);
-
-            // build a normalized structur
-            $def = array(
-                'field'     => isset($params['field']) ? $params['field'] : $name,
-                'type'      => isset($params['type']) ? $params['type'] : null,
-                'params'    => $params,
-            );
-
-            if (isset($def['params']['field'])) {
-                unset($def['params']['field']);
-            }
-            if (isset($def['params']['type'])) {
-                unset($def['params']['type']);
-            }
-
-            $out[$name] = $def;
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getFulltextSpec()
-    {
-        $fields = Config::inst()->get('ShopSearch', 'solr_fulltext_fields');
-        if (empty($fields)) {
-            $fields = array('Title', 'Content');
-        }
-        return $this->scrubFieldList($fields);
-    }
-
-
-    /**
-     *
-     */
-    protected function getFilterSpec()
-    {
-        $fields = Config::inst()->get('ShopSearch', 'solr_filter_fields');
-        return $this->scrubFieldList($fields);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getFieldDefinitions()
-    {
-        $xml = parent::getFieldDefinitions();
+		// This will cause only live pages to be indexed. There are two ways to do
+		// this. See fulltextsearch/docs/en/index.md for more information.
+		// Not sure if this is really the way to go or not, but for now this is it.
+		$this->excludeVariantState(array('SearchVariantVersioned' => 'Stage'));
+	}
+
+
+	/**
+	 * Transforms different formats of field list into something we can pass to solr
+	 * @param array $in
+	 * @return array
+	 */
+	protected function scrubFieldList($in)
+	{
+		$out = array();
+		if (empty($in) || !is_array($in)) {
+			return $out;
+		}
+
+		foreach ($in as $name => $val) {
+			// supports an indexed array format of simple field names
+			if (is_numeric($name)) {
+				$name = $val;
+				$val = true;
+			}
+
+			// supports a boolean value meaning "use the default setup"
+			$params = !is_array($val) ? array() : array_slice($val, 0);
+
+			// build a normalized structur
+			$def = array(
+				'field'     => isset($params['field']) ? $params['field'] : $name,
+				'type'      => isset($params['type']) ? $params['type'] : null,
+				'params'    => $params,
+			);
+
+			if (isset($def['params']['field'])) {
+				unset($def['params']['field']);
+			}
+			if (isset($def['params']['type'])) {
+				unset($def['params']['type']);
+			}
+
+			$out[$name] = $def;
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getFulltextSpec()
+	{
+		$fields = Config::inst()->get('ShopSearch', 'solr_fulltext_fields');
+		if (empty($fields)) {
+			$fields = array('Title', 'Content');
+		}
+		return $this->scrubFieldList($fields);
+	}
+
+
+	/**
+	 *
+	 */
+	protected function getFilterSpec()
+	{
+		$fields = Config::inst()->get('ShopSearch', 'solr_filter_fields');
+		return $this->scrubFieldList($fields);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getFieldDefinitions()
+	{
+		$xml = parent::getFieldDefinitions();
 //		$xml .= "\n\t\t<field name='_spellcheckContent' type='htmltext' indexed='true' stored='false' multiValued='true' />";
 
-        // create a sorting column
-        if (isset($this->fieldMap['Title']) || ShopSearch::config()->solr_title_sort_field) {
-            $f = empty(ShopSearch::config()->title_sort_field) ? '_titleSort' : ShopSearch::config()->solr_title_sort_field;
-            $xml .= "\n\t\t" . '<field name="' . $f . '" type="alphaOnlySort" indexed="true" stored="false" required="false" multiValued="false" />';
-            $xml .= "\n\t\t" . '<copyField source="SiteTree_Title" dest="' . $f . '"/>';
-        }
-
-        // create an autocomplete column
-        if (ShopSearch::config()->suggest_enabled) {
-            $xml .= "\n\t\t<field name='_autocomplete' type='autosuggest_text' indexed='true' stored='false' multiValued='true'/>";
-        }
-
-        return $xml;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getCopyFieldDefinitions()
-    {
-        $xml = parent::getCopyFieldDefinitions();
-
-        if (ShopSearch::config()->suggest_enabled) {
-            foreach ($this->fulltextFields as $name => $field) {
-                $xml .= "\n\t<copyField source='{$name}' dest='_autocomplete' />";
-                //$xml .= "\n\t<copyField source='{$name}' dest='_spellcheckContent' />";
-            }
-        }
-
-        return $xml;
-    }
-
-
-        /**
-     * Overrides the parent to add a field for autocomplete
-     * @return HTMLText
-     */
-    public function getTypes()
-    {
-        $val = parent::getTypes();
-        if (!$val || !is_object($val)) {
-            return $val;
-        }
-        $xml = $val->getValue();
-        $xml .= <<<XML
+		// create a sorting column
+		if (isset($this->fieldMap['Title']) || ShopSearch::config()->solr_title_sort_field) {
+			$f = empty(ShopSearch::config()->title_sort_field) ? '_titleSort' : ShopSearch::config()->solr_title_sort_field;
+			$xml .= "\n\t\t" . '<field name="' . $f . '" type="alphaOnlySort" indexed="true" stored="false" required="false" multiValued="false" />';
+			$xml .= "\n\t\t" . '<copyField source="SiteTree_Title" dest="' . $f . '"/>';
+		}
+
+		// create an autocomplete column
+		if (ShopSearch::config()->suggest_enabled) {
+			$xml .= "\n\t\t<field name='_autocomplete' type='autosuggest_text' indexed='true' stored='false' multiValued='true'/>";
+		}
+
+		return $xml;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getCopyFieldDefinitions()
+	{
+		$xml = parent::getCopyFieldDefinitions();
+
+		if (ShopSearch::config()->suggest_enabled) {
+			foreach ($this->fulltextFields as $name => $field) {
+				$xml .= "\n\t<copyField source='{$name}' dest='_autocomplete' />";
+				//$xml .= "\n\t<copyField source='{$name}' dest='_spellcheckContent' />";
+			}
+		}
+
+		return $xml;
+	}
+
+
+		/**
+		 * Overrides the parent to add a field for autocomplete
+		 * @return HTMLText
+		 */
+	public function getTypes()
+	{
+		$val = parent::getTypes();
+		if (!$val || !is_object($val)) {
+			return $val;
+		}
+		$xml = $val->getValue();
+		$xml .= <<<XML
 
 	        <fieldType name="autosuggest_text" class="solr.TextField"
 	                   positionIncrementGap="100">
@@ -234,89 +234,89 @@ 
 	        </fieldType>
 
 XML;
-        $val->setValue($xml);
-        return $val;
-    }
-
-    /**
-     * This is an intermediary to bridge the search form input
-     * and the SearchQuery class. It allows us to have other
-     * drivers that may not use the FullTextSearch module.
-     *
-     * @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='score desc')
-    {
-        $query = new SearchQuery();
-        $params = array(
-            'sort'  => $sort,
-        );
-
-        // swap out title search
-        if ($params['sort'] == 'SiteTree_Title') {
-            $params['sort'] = '_titleSort';
-        }
-
-        // search by keywords
-        $query->search(empty($keywords) ? '*:*' : $keywords);
-
-        // search by filter
-        foreach ($filters as $k => $v) {
-            if (isset($this->fieldMap[$k])) {
-                if (is_string($v) && preg_match('/^RANGE\~(.+)\~(.+)$/', $v, $m)) {
-                    // Is it a range value?
-                    $range = new SearchQuery_Range($m[1], $m[2]);
-                    $query->filter($this->fieldMap[$k], $range);
-                } else {
-                    // Or a normal scalar value
-                    $query->filter($this->fieldMap[$k], $v);
-                }
-            }
-        }
-
-        // add facets
-        $facetSpec = FacetHelper::inst()->expandFacetSpec($facetSpec);
-        $params += $this->buildFacetParams($facetSpec);
-
-        // TODO: add spellcheck
-
-        return $this->search($query, $start, $limit, $params, $facetSpec);
-    }
-
-
-    /**
-     * @param string $keywords
-     * @param array  $filters
-     * @return array
-     */
-    public function suggestWithResults($keywords, array $filters = array())
-    {
-        $limit      = (int)ShopSearch::config()->sayt_limit;
-
-        // process the keywords a bit
-        $terms      = preg_split('/\s+/', trim(strtolower($keywords)));
-        $lastTerm   = count($terms) > 0 ? array_pop($terms) : '';
-        $prefix     = count($terms) > 0 ? implode(' ', $terms) . ' ' : '';
-        //$terms[]    = $lastTerm;
-        $terms[]    = $lastTerm . '*'; // this allows for partial words to still match
-
-        // convert that to something solr adapater can handle
-        $query = new SearchQuery();
-        $query->search('+' . implode(' +', $terms));
-
-        $params = array(
-            'sort'          => 'score desc',
-            'facet'         => 'true',
-            'facet.field'   => '_autocomplete',
-            'facet.limit'   => ShopSearch::config()->suggest_limit,
-            'facet.prefix'  => $lastTerm,
-        );
+		$val->setValue($xml);
+		return $val;
+	}
+
+	/**
+	 * This is an intermediary to bridge the search form input
+	 * and the SearchQuery class. It allows us to have other
+	 * drivers that may not use the FullTextSearch module.
+	 *
+	 * @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='score desc')
+	{
+		$query = new SearchQuery();
+		$params = array(
+			'sort'  => $sort,
+		);
+
+		// swap out title search
+		if ($params['sort'] == 'SiteTree_Title') {
+			$params['sort'] = '_titleSort';
+		}
+
+		// search by keywords
+		$query->search(empty($keywords) ? '*:*' : $keywords);
+
+		// search by filter
+		foreach ($filters as $k => $v) {
+			if (isset($this->fieldMap[$k])) {
+				if (is_string($v) && preg_match('/^RANGE\~(.+)\~(.+)$/', $v, $m)) {
+					// Is it a range value?
+					$range = new SearchQuery_Range($m[1], $m[2]);
+					$query->filter($this->fieldMap[$k], $range);
+				} else {
+					// Or a normal scalar value
+					$query->filter($this->fieldMap[$k], $v);
+				}
+			}
+		}
+
+		// add facets
+		$facetSpec = FacetHelper::inst()->expandFacetSpec($facetSpec);
+		$params += $this->buildFacetParams($facetSpec);
+
+		// TODO: add spellcheck
+
+		return $this->search($query, $start, $limit, $params, $facetSpec);
+	}
+
+
+	/**
+	 * @param string $keywords
+	 * @param array  $filters
+	 * @return array
+	 */
+	public function suggestWithResults($keywords, array $filters = array())
+	{
+		$limit      = (int)ShopSearch::config()->sayt_limit;
+
+		// process the keywords a bit
+		$terms      = preg_split('/\s+/', trim(strtolower($keywords)));
+		$lastTerm   = count($terms) > 0 ? array_pop($terms) : '';
+		$prefix     = count($terms) > 0 ? implode(' ', $terms) . ' ' : '';
+		//$terms[]    = $lastTerm;
+		$terms[]    = $lastTerm . '*'; // this allows for partial words to still match
+
+		// convert that to something solr adapater can handle
+		$query = new SearchQuery();
+		$query->search('+' . implode(' +', $terms));
+
+		$params = array(
+			'sort'          => 'score desc',
+			'facet'         => 'true',
+			'facet.field'   => '_autocomplete',
+			'facet.limit'   => ShopSearch::config()->suggest_limit,
+			'facet.prefix'  => $lastTerm,
+		);
 
 //		$facetSpec = array(
 //			'_autocomplete' => array(
@@ -335,14 +335,14 @@ 
 //		$suggestsion = array();
 ////		if ($)
 
-        $service = $this->getService();
+		$service = $this->getService();
 
-        SearchVariant::with(count($query->classes) == 1 ? $query->classes[0]['class'] : null)->call('alterQuery', $query, $this);
+		SearchVariant::with(count($query->classes) == 1 ? $query->classes[0]['class'] : null)->call('alterQuery', $query, $this);
 
-        $q = $terms;
-        $fq = array();
+		$q = $terms;
+		$fq = array();
 
-        // Build the search itself
+		// Build the search itself
 //		foreach ($query->search as $search) {
 //			$text = $search['text'];
 //			preg_match_all('/"[^"]*"|\S+/', $text, $parts);
@@ -366,408 +366,408 @@ 
 //			}
 //		}
 
-        // Filter by class if requested
-        $classq = array();
-
-        foreach ($query->classes as $class) {
-            if (!empty($class['includeSubclasses'])) {
-                $classq[] = 'ClassHierarchy:'.$class['class'];
-            } else {
-                $classq[] = 'ClassName:'.$class['class'];
-            }
-        }
-
-        if ($classq) {
-            $fq[] = '+('.implode(' ', $classq).')';
-        }
-
-        // Filter by filters
-        foreach ($query->require as $field => $values) {
-            $requireq = array();
-
-            foreach ($values as $value) {
-                if ($value === SearchQuery::$missing) {
-                    $requireq[] = "(*:* -{$field}:[* TO *])";
-                } elseif ($value === SearchQuery::$present) {
-                    $requireq[] = "{$field}:[* TO *]";
-                } elseif ($value instanceof SearchQuery_Range) {
-                    $start = $value->start;
-                    if ($start === null) {
-                        $start = '*';
-                    }
-                    $end = $value->end;
-                    if ($end === null) {
-                        $end = '*';
-                    }
-                    $requireq[] = "$field:[$start TO $end]";
-                } else {
-                    $requireq[] = $field.':"'.$value.'"';
-                }
-            }
-
-            $fq[] = '+('.implode(' ', $requireq).')';
-        }
-
-        foreach ($query->exclude as $field => $values) {
-            $excludeq = array();
-            $missing = false;
-
-            foreach ($values as $value) {
-                if ($value === SearchQuery::$missing) {
-                    $missing = true;
-                } elseif ($value === SearchQuery::$present) {
-                    $excludeq[] = "{$field}:[* TO *]";
-                } elseif ($value instanceof SearchQuery_Range) {
-                    $start = $value->start;
-                    if ($start === null) {
-                        $start = '*';
-                    }
-                    $end = $value->end;
-                    if ($end === null) {
-                        $end = '*';
-                    }
-                    $excludeq[] = "$field:[$start TO $end]";
-                } else {
-                    $excludeq[] = $field.':"'.$value.'"';
-                }
-            }
-
-            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
-        }
+		// Filter by class if requested
+		$classq = array();
+
+		foreach ($query->classes as $class) {
+			if (!empty($class['includeSubclasses'])) {
+				$classq[] = 'ClassHierarchy:'.$class['class'];
+			} else {
+				$classq[] = 'ClassName:'.$class['class'];
+			}
+		}
+
+		if ($classq) {
+			$fq[] = '+('.implode(' ', $classq).')';
+		}
+
+		// Filter by filters
+		foreach ($query->require as $field => $values) {
+			$requireq = array();
+
+			foreach ($values as $value) {
+				if ($value === SearchQuery::$missing) {
+					$requireq[] = "(*:* -{$field}:[* TO *])";
+				} elseif ($value === SearchQuery::$present) {
+					$requireq[] = "{$field}:[* TO *]";
+				} elseif ($value instanceof SearchQuery_Range) {
+					$start = $value->start;
+					if ($start === null) {
+						$start = '*';
+					}
+					$end = $value->end;
+					if ($end === null) {
+						$end = '*';
+					}
+					$requireq[] = "$field:[$start TO $end]";
+				} else {
+					$requireq[] = $field.':"'.$value.'"';
+				}
+			}
+
+			$fq[] = '+('.implode(' ', $requireq).')';
+		}
+
+		foreach ($query->exclude as $field => $values) {
+			$excludeq = array();
+			$missing = false;
+
+			foreach ($values as $value) {
+				if ($value === SearchQuery::$missing) {
+					$missing = true;
+				} elseif ($value === SearchQuery::$present) {
+					$excludeq[] = "{$field}:[* TO *]";
+				} elseif ($value instanceof SearchQuery_Range) {
+					$start = $value->start;
+					if ($start === null) {
+						$start = '*';
+					}
+					$end = $value->end;
+					if ($end === null) {
+						$end = '*';
+					}
+					$excludeq[] = "$field:[$start TO $end]";
+				} else {
+					$excludeq[] = $field.':"'.$value.'"';
+				}
+			}
+
+			$fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
+		}
 
 //		if(!headers_sent()) {
 //			if ($q) header('X-Query: '.implode(' ', $q));
 //			if ($fq) header('X-Filters: "'.implode('", "', $fq).'"');
 //		}
 
-        $params = array_merge($params, array('fq' => implode(' ', $fq)));
-
-        $res = $service->search(
-            implode(' ', $q),
-            0,
-            $limit,
-            $params,
-            Apache_Solr_Service::METHOD_POST
-        );
-
-        $results = new ArrayList();
-        if ($res->getHttpStatus() >= 200 && $res->getHttpStatus() < 300) {
-            foreach ($res->response->docs as $doc) {
-                $result = DataObject::get_by_id($doc->ClassName, $doc->ID);
-                if ($result) {
-                    $results->push($result);
-                }
-            }
-            $numFound = $res->response->numFound;
-        } else {
-            $numFound = 0;
-        }
-
-        $ret = array();
-        $ret['products'] = new PaginatedList($results);
-        $ret['products']->setLimitItems(false);
-        $ret['products']->setTotalItems($numFound);
-        $ret['products']->setPageStart(0);
-        $ret['products']->setPageLength($limit);
-
-        // Facets (this is how we're doing suggestions for now...
-        $ret['suggestions'] = array();
-        if (isset($res->facet_counts->facet_fields->_autocomplete)) {
-            foreach ($res->facet_counts->facet_fields->_autocomplete as $term => $count) {
-                $ret['suggestions'][] = $prefix . $term;
-            }
-        }
-
-        // Suggestions (requires custom setup, assumes spellcheck.collate=true)
+		$params = array_merge($params, array('fq' => implode(' ', $fq)));
+
+		$res = $service->search(
+			implode(' ', $q),
+			0,
+			$limit,
+			$params,
+			Apache_Solr_Service::METHOD_POST
+		);
+
+		$results = new ArrayList();
+		if ($res->getHttpStatus() >= 200 && $res->getHttpStatus() < 300) {
+			foreach ($res->response->docs as $doc) {
+				$result = DataObject::get_by_id($doc->ClassName, $doc->ID);
+				if ($result) {
+					$results->push($result);
+				}
+			}
+			$numFound = $res->response->numFound;
+		} else {
+			$numFound = 0;
+		}
+
+		$ret = array();
+		$ret['products'] = new PaginatedList($results);
+		$ret['products']->setLimitItems(false);
+		$ret['products']->setTotalItems($numFound);
+		$ret['products']->setPageStart(0);
+		$ret['products']->setPageLength($limit);
+
+		// Facets (this is how we're doing suggestions for now...
+		$ret['suggestions'] = array();
+		if (isset($res->facet_counts->facet_fields->_autocomplete)) {
+			foreach ($res->facet_counts->facet_fields->_autocomplete as $term => $count) {
+				$ret['suggestions'][] = $prefix . $term;
+			}
+		}
+
+		// Suggestions (requires custom setup, assumes spellcheck.collate=true)
 //		if(isset($res->spellcheck->suggestions->collation)) {
 //			$ret['Suggestion'] = $res->spellcheck->suggestions->collation;
 //		}
 
-        return $ret;
-    }
-
-    /**
-     * @param $facets
-     * @return array
-     */
-    protected function buildFacetParams(array $facets)
-    {
-        $params = array();
-
-        if (!empty($facets)) {
-            $params['facet'] = 'true';
-
-            foreach ($facets as $name => $spec) {
-                // With our current implementation, "range" facets aren't true facets in solr terms.
-                // They're just a type of filter which can be handled elsewhere.
-                // For the other types we just ignore the rest of the spec and let Solr do its thing
-                if ($spec['Type'] != ShopSearch::FACET_TYPE_RANGE && isset($this->fieldMap[$name])) {
-                    $params['facet.field'] = $this->fieldMap[$name];
-                }
-            }
-        }
-
-        return $params;
-    }
-
-
-    /**
-     * Fulltextsearch module doesn't yet support facets very well, so I've just copied this function here so
-     * we have access to the results. I'd prefer to modify it minimally so we can eventually get rid of it
-     * once they add faceting or hooks to get directly at the returned response.
-     *
-     * @param SearchQuery $query
-     * @param integer $offset
-     * @param integer $limit
-     * @param  Array $params Extra request parameters passed through to Solr
-     * @param array $facetSpec - Added for ShopSearch so we can process the facets
-     * @return ArrayData Map with the following keys:
-     *  - 'Matches': ArrayList of the matched object instances
-     */
-    public function search(SearchQuery $query, $offset = -1, $limit = -1, $params = array(), $facetSpec = array())
-    {
-        $service = $this->getService();
-
-        SearchVariant::with(count($query->classes) == 1 ? $query->classes[0]['class'] : null)->call('alterQuery', $query, $this);
-
-        $q = array();
-        $fq = array();
-
-        // Build the search itself
-
-        foreach ($query->search as $search) {
-            $text = $search['text'];
-            preg_match_all('/"[^"]*"|\S+/', $text, $parts);
-
-            $fuzzy = $search['fuzzy'] ? '~' : '';
-
-            foreach ($parts[0] as $part) {
-                $fields = (isset($search['fields'])) ? $search['fields'] : array();
-                if (isset($search['boost'])) {
-                    $fields = array_merge($fields, array_keys($search['boost']));
-                }
-                if ($fields) {
-                    $searchq = array();
-                    foreach ($fields as $field) {
-                        $boost = (isset($search['boost'][$field])) ? '^' . $search['boost'][$field] : '';
-                        $searchq[] = "{$field}:".$part.$fuzzy.$boost;
-                    }
-                    $q[] = '+('.implode(' OR ', $searchq).')';
-                } else {
-                    $q[] = '+'.$part.$fuzzy;
-                }
-            }
-        }
-
-        // Filter by class if requested
-
-        $classq = array();
-
-        foreach ($query->classes as $class) {
-            if (!empty($class['includeSubclasses'])) {
-                $classq[] = 'ClassHierarchy:'.$class['class'];
-            } else {
-                $classq[] = 'ClassName:'.$class['class'];
-            }
-        }
-
-        if ($classq) {
-            $fq[] = '+('.implode(' ', $classq).')';
-        }
-
-        // Filter by filters
-
-        foreach ($query->require as $field => $values) {
-            $requireq = array();
-
-            foreach ($values as $value) {
-                if ($value === SearchQuery::$missing) {
-                    $requireq[] = "(*:* -{$field}:[* TO *])";
-                } elseif ($value === SearchQuery::$present) {
-                    $requireq[] = "{$field}:[* TO *]";
-                } elseif ($value instanceof SearchQuery_Range) {
-                    $start = $value->start;
-                    if ($start === null) {
-                        $start = '*';
-                    }
-                    $end = $value->end;
-                    if ($end === null) {
-                        $end = '*';
-                    }
-                    $requireq[] = "$field:[$start TO $end]";
-                } else {
-                    $requireq[] = $field.':"'.$value.'"';
-                }
-            }
-
-            $fq[] = '+('.implode(' ', $requireq).')';
-        }
-
-        foreach ($query->exclude as $field => $values) {
-            $excludeq = array();
-            $missing = false;
-
-            foreach ($values as $value) {
-                if ($value === SearchQuery::$missing) {
-                    $missing = true;
-                } elseif ($value === SearchQuery::$present) {
-                    $excludeq[] = "{$field}:[* TO *]";
-                } elseif ($value instanceof SearchQuery_Range) {
-                    $start = $value->start;
-                    if ($start === null) {
-                        $start = '*';
-                    }
-                    $end = $value->end;
-                    if ($end === null) {
-                        $end = '*';
-                    }
-                    $excludeq[] = "$field:[$start TO $end]";
-                } else {
-                    $excludeq[] = $field.':"'.$value.'"';
-                }
-            }
-
-            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
-        }
+		return $ret;
+	}
+
+	/**
+	 * @param $facets
+	 * @return array
+	 */
+	protected function buildFacetParams(array $facets)
+	{
+		$params = array();
+
+		if (!empty($facets)) {
+			$params['facet'] = 'true';
+
+			foreach ($facets as $name => $spec) {
+				// With our current implementation, "range" facets aren't true facets in solr terms.
+				// They're just a type of filter which can be handled elsewhere.
+				// For the other types we just ignore the rest of the spec and let Solr do its thing
+				if ($spec['Type'] != ShopSearch::FACET_TYPE_RANGE && isset($this->fieldMap[$name])) {
+					$params['facet.field'] = $this->fieldMap[$name];
+				}
+			}
+		}
+
+		return $params;
+	}
+
+
+	/**
+	 * Fulltextsearch module doesn't yet support facets very well, so I've just copied this function here so
+	 * we have access to the results. I'd prefer to modify it minimally so we can eventually get rid of it
+	 * once they add faceting or hooks to get directly at the returned response.
+	 *
+	 * @param SearchQuery $query
+	 * @param integer $offset
+	 * @param integer $limit
+	 * @param  Array $params Extra request parameters passed through to Solr
+	 * @param array $facetSpec - Added for ShopSearch so we can process the facets
+	 * @return ArrayData Map with the following keys:
+	 *  - 'Matches': ArrayList of the matched object instances
+	 */
+	public function search(SearchQuery $query, $offset = -1, $limit = -1, $params = array(), $facetSpec = array())
+	{
+		$service = $this->getService();
+
+		SearchVariant::with(count($query->classes) == 1 ? $query->classes[0]['class'] : null)->call('alterQuery', $query, $this);
+
+		$q = array();
+		$fq = array();
+
+		// Build the search itself
+
+		foreach ($query->search as $search) {
+			$text = $search['text'];
+			preg_match_all('/"[^"]*"|\S+/', $text, $parts);
+
+			$fuzzy = $search['fuzzy'] ? '~' : '';
+
+			foreach ($parts[0] as $part) {
+				$fields = (isset($search['fields'])) ? $search['fields'] : array();
+				if (isset($search['boost'])) {
+					$fields = array_merge($fields, array_keys($search['boost']));
+				}
+				if ($fields) {
+					$searchq = array();
+					foreach ($fields as $field) {
+						$boost = (isset($search['boost'][$field])) ? '^' . $search['boost'][$field] : '';
+						$searchq[] = "{$field}:".$part.$fuzzy.$boost;
+					}
+					$q[] = '+('.implode(' OR ', $searchq).')';
+				} else {
+					$q[] = '+'.$part.$fuzzy;
+				}
+			}
+		}
+
+		// Filter by class if requested
+
+		$classq = array();
+
+		foreach ($query->classes as $class) {
+			if (!empty($class['includeSubclasses'])) {
+				$classq[] = 'ClassHierarchy:'.$class['class'];
+			} else {
+				$classq[] = 'ClassName:'.$class['class'];
+			}
+		}
+
+		if ($classq) {
+			$fq[] = '+('.implode(' ', $classq).')';
+		}
+
+		// Filter by filters
+
+		foreach ($query->require as $field => $values) {
+			$requireq = array();
+
+			foreach ($values as $value) {
+				if ($value === SearchQuery::$missing) {
+					$requireq[] = "(*:* -{$field}:[* TO *])";
+				} elseif ($value === SearchQuery::$present) {
+					$requireq[] = "{$field}:[* TO *]";
+				} elseif ($value instanceof SearchQuery_Range) {
+					$start = $value->start;
+					if ($start === null) {
+						$start = '*';
+					}
+					$end = $value->end;
+					if ($end === null) {
+						$end = '*';
+					}
+					$requireq[] = "$field:[$start TO $end]";
+				} else {
+					$requireq[] = $field.':"'.$value.'"';
+				}
+			}
+
+			$fq[] = '+('.implode(' ', $requireq).')';
+		}
+
+		foreach ($query->exclude as $field => $values) {
+			$excludeq = array();
+			$missing = false;
+
+			foreach ($values as $value) {
+				if ($value === SearchQuery::$missing) {
+					$missing = true;
+				} elseif ($value === SearchQuery::$present) {
+					$excludeq[] = "{$field}:[* TO *]";
+				} elseif ($value instanceof SearchQuery_Range) {
+					$start = $value->start;
+					if ($start === null) {
+						$start = '*';
+					}
+					$end = $value->end;
+					if ($end === null) {
+						$end = '*';
+					}
+					$excludeq[] = "$field:[$start TO $end]";
+				} else {
+					$excludeq[] = $field.':"'.$value.'"';
+				}
+			}
+
+			$fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
+		}
 
 //		if(!headers_sent()) {
 //			if ($q) header('X-Query: '.implode(' ', $q));
 //			if ($fq) header('X-Filters: "'.implode('", "', $fq).'"');
 //		}
 
-        if ($offset == -1) {
-            $offset = $query->start;
-        }
-        if ($limit == -1) {
-            $limit = $query->limit;
-        }
-        if ($limit == -1) {
-            $limit = SearchQuery::$default_page_size;
-        }
-
-        $params = array_merge($params, array('fq' => implode(' ', $fq)));
-
-        $res = $service->search(
-            $q ? implode(' ', $q) : '*:*',
-            $offset,
-            $limit,
-            $params,
-            Apache_Solr_Service::METHOD_POST
-        );
-        //Debug::dump($res);
-
-        $results = new ArrayList();
-        if ($res->getHttpStatus() >= 200 && $res->getHttpStatus() < 300) {
-            foreach ($res->response->docs as $doc) {
-                $result = DataObject::get_by_id($doc->ClassName, $doc->ID);
-                if ($result) {
-                    $results->push($result);
-
-                    // Add highlighting (optional)
-                    $docId = $doc->_documentid;
-                    if ($res->highlighting && $res->highlighting->$docId) {
-                        // TODO Create decorator class for search results rather than adding arbitrary object properties
-                        // TODO Allow specifying highlighted field, and lazy loading
-                        // in case the search API needs another query (similar to SphinxSearchable->buildExcerpt()).
-                        $combinedHighlights = array();
-                        foreach ($res->highlighting->$docId as $field => $highlights) {
-                            $combinedHighlights = array_merge($combinedHighlights, $highlights);
-                        }
-
-                        // Remove entity-encoded U+FFFD replacement character. It signifies non-displayable characters,
-                        // and shows up as an encoding error in browsers.
-                        $result->Excerpt = DBField::create_field(
-                            'HTMLText',
-                            str_replace(
-                                '&#65533;',
-                                '',
-                                implode(' ... ', $combinedHighlights)
-                            )
-                        );
-                    }
-                }
-            }
-            $numFound = $res->response->numFound;
-        } else {
-            $numFound = 0;
-        }
-
-        $ret = array();
-        $ret['Matches'] = new PaginatedList($results);
-        $ret['Matches']->setLimitItems(false);
-        // Tell PaginatedList how many results there are
-        $ret['Matches']->setTotalItems($numFound);
-        // Results for current page start at $offset
-        $ret['Matches']->setPageStart($offset);
-        // Results per page
-        $ret['Matches']->setPageLength($limit);
-
-        // Facets
-        //Debug::dump($res);
-        if (isset($res->facet_counts->facet_fields)) {
-            $ret['Facets'] = $this->buildFacetResults($res->facet_counts->facet_fields, $facetSpec);
-        }
-
-        // Suggestions (requires custom setup, assumes spellcheck.collate=true)
-        if (isset($res->spellcheck->suggestions->collation)) {
-            $ret['Suggestion'] = $res->spellcheck->suggestions->collation;
-        }
-
-        return new ArrayData($ret);
-    }
-
-
-    /**
-     * @param stdClass $facetFields
-     * @param array $facetSpec
-     * @return ArrayList
-     */
-    protected function buildFacetResults($facetFields, array $facetSpec)
-    {
-        $out = new ArrayList;
-
-        foreach ($facetSpec as $field => $facet) {
-            if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
-                // If it's a range facet, set up the min/max
-                // TODO: we could probably get the real min and max with solr's range faceting if we tried
-                if (isset($facet['RangeMin'])) {
-                    $facet['MinValue'] = $facet['RangeMin'];
-                }
-                if (isset($facet['RangeMax'])) {
-                    $facet['MaxValue'] = $facet['RangeMax'];
-                }
-                $out->push(new ArrayData($facet));
-            } elseif (isset($this->fieldMap[$field])) {
-                // Otherwise, look through Solr's results
-                $mySolrName = $this->fieldMap[$field];
-                foreach ($facetFields as $solrName => $values) {
-                    if ($solrName == $mySolrName) {
-                        // we found a match, look through the values we were given
-                        foreach ($values as $val => $count) {
-                            if (!isset($facet['Values'][$val])) {
-                                // for link type facets we want to add anything
-                                // for checkboxes, if it's not in the provided list we leave it out
-                                if ($facet['Type'] != ShopSearch::FACET_TYPE_CHECKBOX && $count > 0) {
-                                    $facet['Values'][$val] = new ArrayData(array(
-                                        'Label'     => $val,
-                                        'Value'     => $val,
-                                        'Count'     => $count,
-                                    ));
-                                }
-                            } elseif ($facet['Values'][$val]) {
-                                $facet['Values'][$val]->Count = $count;
-                            }
-                        }
-                    }
-                }
-
-                // then add that to the stack
-                $facet['Values'] = new ArrayList($facet['Values']);
-                $out->push(new ArrayData($facet));
-            }
-        }
-
-        //Debug::dump($out);
-        return $out;
-    }
+		if ($offset == -1) {
+			$offset = $query->start;
+		}
+		if ($limit == -1) {
+			$limit = $query->limit;
+		}
+		if ($limit == -1) {
+			$limit = SearchQuery::$default_page_size;
+		}
+
+		$params = array_merge($params, array('fq' => implode(' ', $fq)));
+
+		$res = $service->search(
+			$q ? implode(' ', $q) : '*:*',
+			$offset,
+			$limit,
+			$params,
+			Apache_Solr_Service::METHOD_POST
+		);
+		//Debug::dump($res);
+
+		$results = new ArrayList();
+		if ($res->getHttpStatus() >= 200 && $res->getHttpStatus() < 300) {
+			foreach ($res->response->docs as $doc) {
+				$result = DataObject::get_by_id($doc->ClassName, $doc->ID);
+				if ($result) {
+					$results->push($result);
+
+					// Add highlighting (optional)
+					$docId = $doc->_documentid;
+					if ($res->highlighting && $res->highlighting->$docId) {
+						// TODO Create decorator class for search results rather than adding arbitrary object properties
+						// TODO Allow specifying highlighted field, and lazy loading
+						// in case the search API needs another query (similar to SphinxSearchable->buildExcerpt()).
+						$combinedHighlights = array();
+						foreach ($res->highlighting->$docId as $field => $highlights) {
+							$combinedHighlights = array_merge($combinedHighlights, $highlights);
+						}
+
+						// Remove entity-encoded U+FFFD replacement character. It signifies non-displayable characters,
+						// and shows up as an encoding error in browsers.
+						$result->Excerpt = DBField::create_field(
+							'HTMLText',
+							str_replace(
+								'&#65533;',
+								'',
+								implode(' ... ', $combinedHighlights)
+							)
+						);
+					}
+				}
+			}
+			$numFound = $res->response->numFound;
+		} else {
+			$numFound = 0;
+		}
+
+		$ret = array();
+		$ret['Matches'] = new PaginatedList($results);
+		$ret['Matches']->setLimitItems(false);
+		// Tell PaginatedList how many results there are
+		$ret['Matches']->setTotalItems($numFound);
+		// Results for current page start at $offset
+		$ret['Matches']->setPageStart($offset);
+		// Results per page
+		$ret['Matches']->setPageLength($limit);
+
+		// Facets
+		//Debug::dump($res);
+		if (isset($res->facet_counts->facet_fields)) {
+			$ret['Facets'] = $this->buildFacetResults($res->facet_counts->facet_fields, $facetSpec);
+		}
+
+		// Suggestions (requires custom setup, assumes spellcheck.collate=true)
+		if (isset($res->spellcheck->suggestions->collation)) {
+			$ret['Suggestion'] = $res->spellcheck->suggestions->collation;
+		}
+
+		return new ArrayData($ret);
+	}
+
+
+	/**
+	 * @param stdClass $facetFields
+	 * @param array $facetSpec
+	 * @return ArrayList
+	 */
+	protected function buildFacetResults($facetFields, array $facetSpec)
+	{
+		$out = new ArrayList;
+
+		foreach ($facetSpec as $field => $facet) {
+			if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
+				// If it's a range facet, set up the min/max
+				// TODO: we could probably get the real min and max with solr's range faceting if we tried
+				if (isset($facet['RangeMin'])) {
+					$facet['MinValue'] = $facet['RangeMin'];
+				}
+				if (isset($facet['RangeMax'])) {
+					$facet['MaxValue'] = $facet['RangeMax'];
+				}
+				$out->push(new ArrayData($facet));
+			} elseif (isset($this->fieldMap[$field])) {
+				// Otherwise, look through Solr's results
+				$mySolrName = $this->fieldMap[$field];
+				foreach ($facetFields as $solrName => $values) {
+					if ($solrName == $mySolrName) {
+						// we found a match, look through the values we were given
+						foreach ($values as $val => $count) {
+							if (!isset($facet['Values'][$val])) {
+								// for link type facets we want to add anything
+								// for checkboxes, if it's not in the provided list we leave it out
+								if ($facet['Type'] != ShopSearch::FACET_TYPE_CHECKBOX && $count > 0) {
+									$facet['Values'][$val] = new ArrayData(array(
+										'Label'     => $val,
+										'Value'     => $val,
+										'Count'     => $count,
+									));
+								}
+							} elseif ($facet['Values'][$val]) {
+								$facet['Values'][$val]->Count = $count;
+							}
+						}
+					}
+				}
+
+				// then add that to the stack
+				$facet['Values'] = new ArrayList($facet['Values']);
+				$out->push(new ArrayData($facet));
+			}
+		}
+
+		//Debug::dump($out);
+		return $out;
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -251,7 +251,7 @@ 
      * @param string $sort [optional]
      * @return ArrayData
      */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='score desc')
+    public function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = 'score desc')
     {
         $query = new SearchQuery();
         $params = array(
@@ -371,14 +371,14 @@ 
 
         foreach ($query->classes as $class) {
             if (!empty($class['includeSubclasses'])) {
-                $classq[] = 'ClassHierarchy:'.$class['class'];
+                $classq[] = 'ClassHierarchy:' . $class['class'];
             } else {
-                $classq[] = 'ClassName:'.$class['class'];
+                $classq[] = 'ClassName:' . $class['class'];
             }
         }
 
         if ($classq) {
-            $fq[] = '+('.implode(' ', $classq).')';
+            $fq[] = '+(' . implode(' ', $classq) . ')';
         }
 
         // Filter by filters
@@ -401,11 +401,11 @@ 
                     }
                     $requireq[] = "$field:[$start TO $end]";
                 } else {
-                    $requireq[] = $field.':"'.$value.'"';
+                    $requireq[] = $field . ':"' . $value . '"';
                 }
             }
 
-            $fq[] = '+('.implode(' ', $requireq).')';
+            $fq[] = '+(' . implode(' ', $requireq) . ')';
         }
 
         foreach ($query->exclude as $field => $values) {
@@ -428,11 +428,11 @@ 
                     }
                     $excludeq[] = "$field:[$start TO $end]";
                 } else {
-                    $excludeq[] = $field.':"'.$value.'"';
+                    $excludeq[] = $field . ':"' . $value . '"';
                 }
             }
 
-            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
+            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-(' . implode(' ', $excludeq) . ')';
         }
 
 //		if(!headers_sent()) {
@@ -550,11 +550,11 @@ 
                     $searchq = array();
                     foreach ($fields as $field) {
                         $boost = (isset($search['boost'][$field])) ? '^' . $search['boost'][$field] : '';
-                        $searchq[] = "{$field}:".$part.$fuzzy.$boost;
+                        $searchq[] = "{$field}:" . $part . $fuzzy . $boost;
                     }
-                    $q[] = '+('.implode(' OR ', $searchq).')';
+                    $q[] = '+(' . implode(' OR ', $searchq) . ')';
                 } else {
-                    $q[] = '+'.$part.$fuzzy;
+                    $q[] = '+' . $part . $fuzzy;
                 }
             }
         }
@@ -565,14 +565,14 @@ 
 
         foreach ($query->classes as $class) {
             if (!empty($class['includeSubclasses'])) {
-                $classq[] = 'ClassHierarchy:'.$class['class'];
+                $classq[] = 'ClassHierarchy:' . $class['class'];
             } else {
-                $classq[] = 'ClassName:'.$class['class'];
+                $classq[] = 'ClassName:' . $class['class'];
             }
         }
 
         if ($classq) {
-            $fq[] = '+('.implode(' ', $classq).')';
+            $fq[] = '+(' . implode(' ', $classq) . ')';
         }
 
         // Filter by filters
@@ -596,11 +596,11 @@ 
                     }
                     $requireq[] = "$field:[$start TO $end]";
                 } else {
-                    $requireq[] = $field.':"'.$value.'"';
+                    $requireq[] = $field . ':"' . $value . '"';
                 }
             }
 
-            $fq[] = '+('.implode(' ', $requireq).')';
+            $fq[] = '+(' . implode(' ', $requireq) . ')';
         }
 
         foreach ($query->exclude as $field => $values) {
@@ -623,11 +623,11 @@ 
                     }
                     $excludeq[] = "$field:[$start TO $end]";
                 } else {
-                    $excludeq[] = $field.':"'.$value.'"';
+                    $excludeq[] = $field . ':"' . $value . '"';
                 }
             }
 
-            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-('.implode(' ', $excludeq).')';
+            $fq[] = ($missing ? "+{$field}:[* TO *] " : '') . '-(' . implode(' ', $excludeq) . ')';
         }
 
 //		if(!headers_sent()) {

code/helpers/BetweenFilter.php

Indentation +81 added lines, -81 removed lines

@@ -1,98 +1,98 @@
 <?php
 /**
- * Checks if the value is within a range (inclusive). Equivalent
- * of mysql's between statement but doesn't use that for compatibility.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 10.18.2013
- * @package shop_Search
- * @subpackage helpers
- */
+	 * Checks if the value is within a range (inclusive). Equivalent
+	 * of mysql's between statement but doesn't use that for compatibility.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 10.18.2013
+	 * @package shop_Search
+	 * @subpackage helpers
+	 */
 class BetweenFilter extends SearchFilter
 {
-    /**
-     * @param DataQuery $query
-     * @return DataQuery
-     */
-    protected function applyOne(DataQuery $query)
-    {
-        $this->model = $query->applyRelation($this->relation);
-        $value = $this->getDbFormattedValue();
+	/**
+	 * @param DataQuery $query
+	 * @return DataQuery
+	 */
+	protected function applyOne(DataQuery $query)
+	{
+		$this->model = $query->applyRelation($this->relation);
+		$value = $this->getDbFormattedValue();
 
-        if (is_numeric($value)) {
-            $filter = sprintf("%s > %s", $this->getDbName(), Convert::raw2sql($value));
-        } else {
-            $filter = sprintf("%s > '%s'", $this->getDbName(), Convert::raw2sql($value));
-        }
+		if (is_numeric($value)) {
+			$filter = sprintf("%s > %s", $this->getDbName(), Convert::raw2sql($value));
+		} else {
+			$filter = sprintf("%s > '%s'", $this->getDbName(), Convert::raw2sql($value));
+		}
 
-        return $query->where($filter);
-    }
+		return $query->where($filter);
+	}
 
-    /**
-     * @param DataQuery $query
-     * @return DataQuery
-     */
-    protected function excludeOne(DataQuery $query)
-    {
-        $this->model = $query->applyRelation($this->relation);
-        $value = $this->getDbFormattedValue();
+	/**
+	 * @param DataQuery $query
+	 * @return DataQuery
+	 */
+	protected function excludeOne(DataQuery $query)
+	{
+		$this->model = $query->applyRelation($this->relation);
+		$value = $this->getDbFormattedValue();
 
-        if (is_numeric($value)) {
-            $filter = sprintf("%s <= %s", $this->getDbName(), Convert::raw2sql($value));
-        } else {
-            $filter = sprintf("%s <= '%s'", $this->getDbName(), Convert::raw2sql($value));
-        }
+		if (is_numeric($value)) {
+			$filter = sprintf("%s <= %s", $this->getDbName(), Convert::raw2sql($value));
+		} else {
+			$filter = sprintf("%s <= '%s'", $this->getDbName(), Convert::raw2sql($value));
+		}
 
-        return $query->where($filter);
-    }
+		return $query->where($filter);
+	}
 
-    /**
-     * @param DataQuery $query
-     * @return DataQuery
-     */
-    protected function applyMany(DataQuery $query)
-    {
-        $this->model = $query->applyRelation($this->relation);
+	/**
+	 * @param DataQuery $query
+	 * @return DataQuery
+	 */
+	protected function applyMany(DataQuery $query)
+	{
+		$this->model = $query->applyRelation($this->relation);
 
-        $filters = array();
-        $ops = array('>=', '<=');
-        foreach ($this->getValue() as $i => $value) {
-            if (is_numeric($value)) {
-                $filters[] = sprintf("%s %s %s", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
-            } else {
-                $filters[] = sprintf("%s %s '%s'", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
-            }
-        }
+		$filters = array();
+		$ops = array('>=', '<=');
+		foreach ($this->getValue() as $i => $value) {
+			if (is_numeric($value)) {
+				$filters[] = sprintf("%s %s %s", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
+			} else {
+				$filters[] = sprintf("%s %s '%s'", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
+			}
+		}
 
-        return $query->where(implode(' AND ', $filters));
-    }
+		return $query->where(implode(' AND ', $filters));
+	}
 
-    /**
-     * @param DataQuery $query
-     * @return DataQuery
-     */
-    protected function excludeMany(DataQuery $query)
-    {
-        $this->model = $query->applyRelation($this->relation);
+	/**
+	 * @param DataQuery $query
+	 * @return DataQuery
+	 */
+	protected function excludeMany(DataQuery $query)
+	{
+		$this->model = $query->applyRelation($this->relation);
 
-        $filters = array();
-        $ops = array('<', '>');
-        foreach ($this->getValue() as $i => $value) {
-            if (is_numeric($value)) {
-                $filters[] = sprintf("%s %s %s", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
-            } else {
-                $filters[] = sprintf("%s %s '%s'", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
-            }
-        }
+		$filters = array();
+		$ops = array('<', '>');
+		foreach ($this->getValue() as $i => $value) {
+			if (is_numeric($value)) {
+				$filters[] = sprintf("%s %s %s", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
+			} else {
+				$filters[] = sprintf("%s %s '%s'", $this->getDbName(), $ops[$i], Convert::raw2sql($value));
+			}
+		}
 
-        return $query->where(implode(' OR ', $filters));
-    }
+		return $query->where(implode(' OR ', $filters));
+	}
 
-    /**
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->getValue() === array() || $this->getValue() === null || $this->getValue() === '';
-    }
+	/**
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->getValue() === array() || $this->getValue() === null || $this->getValue() === '';
+	}
 }

code/helpers/FacetedCategory.php

Indentation +148 added lines, -148 removed lines

@@ -1,153 +1,153 @@
 <?php
 /**
- * This extension can be applied to ProductCategory
- * to allow categories to have facets as well.
- *
- * NOTE: You could apply this to either ProductCategory
- * or ProductCategory_Controller. I tend to use the model b/c
- * that will also cover some other cases like where you
- * might list subcategory products on the parent category page.
- * In such a case those products would be filtered as well.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 10.22.2013
- * @package shop_search
- * @subpackage helpers
- */
+	 * This extension can be applied to ProductCategory
+	 * to allow categories to have facets as well.
+	 *
+	 * NOTE: You could apply this to either ProductCategory
+	 * or ProductCategory_Controller. I tend to use the model b/c
+	 * that will also cover some other cases like where you
+	 * might list subcategory products on the parent category page.
+	 * In such a case those products would be filtered as well.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 10.22.2013
+	 * @package shop_search
+	 * @subpackage helpers
+	 */
 class FacetedCategory extends SiteTreeExtension
 {
-    private static $db = array(
-        'DisabledFacets' => 'Text', // This will be a comma-delimited list of facets that aren't used for a given category
-    );
-
-    /** @var array - facet definition - see ShopSearch and/or docs/en/Facets.md for format */
-    private static $facets = array();
-
-    /** @var bool - if true there will be a tab in the cms to disable some or all defined facets */
-    private static $show_disabled_facets_tab = true;
-
-    /** @var string - which method should we use to get the child products for FilteredProducts */
-    private static $products_method = 'ProductsShowable';
-
-    /** @var bool - automatically create facets for static attributes */
-    private static $auto_facet_attributes = false;
-
-
-    /**
-     * @param FieldList $fields
-     */
-    public function updateCMSFields(FieldList $fields)
-    {
-        if (Config::inst()->get('FacetedCategory', 'show_disabled_facets_tab')) {
-            $spec = FacetHelper::inst()->expandFacetSpec($this->getFacetSpec());
-            $facets = array();
-            foreach ($spec as $f => $v) {
-                $facets[$f] = $v['Label'];
-            }
-            $fields->addFieldToTab('Root.Facets', CheckboxSetField::create('DisabledFacets', "Don't show the following facets for this category:", $facets));
-        }
-    }
-
-
-    /**
-     * @return Controller
-     */
-    protected function getController()
-    {
-        return ($this->owner instanceof Controller) ? $this->owner : Controller::curr();
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getFacetSpec()
-    {
-        $spec = Config::inst()->get('FacetedCategory', 'facets');
-        return (empty($spec) || !is_array($spec)) ? array() : $spec;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getFilters()
-    {
-        $qs_f       = Config::inst()->get('ShopSearch', 'qs_filters');
-        if (!$qs_f) {
-            return array();
-        }
-        $request    = $this->getController()->getRequest();
-        $filters    = $request->requestVar($qs_f);
-        if (empty($filters) || !is_array($filters)) {
-            return array();
-        }
-        return FacetHelper::inst()->scrubFilters($filters);
-    }
-
-
-    /**
-     * @param bool $recursive
-     * @return mixed
-     */
-    public function FilteredProducts($recursive=true)
-    {
-        if (!isset($this->_filteredProducts)) {
-            $fn = Config::inst()->get('FacetedCategory', 'products_method');
-            if (empty($fn)) {
-                $fn = 'ProductsShowable';
-            }
-            $this->_filteredProducts = $this->owner->$fn($recursive);
-            $this->_filteredProducts = FacetHelper::inst()->addFiltersToDataList($this->_filteredProducts, $this->getFilters());
-        }
-
-        return $this->_filteredProducts;
-    }
-
-    protected $_filteredProducts;
-
-
-    /**
-     * @return array
-     */
-    public function getDisabledFacetsArray()
-    {
-        if (empty($this->owner->DisabledFacets)) {
-            return array();
-        }
-        return explode(',', $this->owner->DisabledFacets);
-    }
-
-
-    /**
-     * @return ArrayList
-     */
-    public function Facets()
-    {
-        $spec       = $this->getFacetSpec();
-        if (empty($spec)) {
-            return new ArrayList;
-        }
-
-        // remove any disabled facets
-        foreach ($this->getDisabledFacetsArray() as $disabled) {
-            if (isset($spec[$disabled])) {
-                unset($spec[$disabled]);
-            }
-        }
-
-        $request    = $this->getController()->getRequest();
-        $baseLink   = $request->getURL(false);
-        $filters    = $this->getFilters();
-        $baseParams = array_merge($request->requestVars(), array());
-        unset($baseParams['url']);
-
-        $products   = $this->owner->hasMethod('ProductsForFaceting') ? $this->owner->ProductsForFaceting() : $this->FilteredProducts();
-        $facets     = FacetHelper::inst()->buildFacets($products, $spec, (bool)Config::inst()->get('FacetedCategory', 'auto_facet_attributes'));
-        $facets     = FacetHelper::inst()->transformHierarchies($facets);
-        $facets     = FacetHelper::inst()->updateFacetState($facets, $filters);
-        $facets     = FacetHelper::inst()->insertFacetLinks($facets, $baseParams, $baseLink);
-
-        return $facets;
-    }
+	private static $db = array(
+		'DisabledFacets' => 'Text', // This will be a comma-delimited list of facets that aren't used for a given category
+	);
+
+	/** @var array - facet definition - see ShopSearch and/or docs/en/Facets.md for format */
+	private static $facets = array();
+
+	/** @var bool - if true there will be a tab in the cms to disable some or all defined facets */
+	private static $show_disabled_facets_tab = true;
+
+	/** @var string - which method should we use to get the child products for FilteredProducts */
+	private static $products_method = 'ProductsShowable';
+
+	/** @var bool - automatically create facets for static attributes */
+	private static $auto_facet_attributes = false;
+
+
+	/**
+	 * @param FieldList $fields
+	 */
+	public function updateCMSFields(FieldList $fields)
+	{
+		if (Config::inst()->get('FacetedCategory', 'show_disabled_facets_tab')) {
+			$spec = FacetHelper::inst()->expandFacetSpec($this->getFacetSpec());
+			$facets = array();
+			foreach ($spec as $f => $v) {
+				$facets[$f] = $v['Label'];
+			}
+			$fields->addFieldToTab('Root.Facets', CheckboxSetField::create('DisabledFacets', "Don't show the following facets for this category:", $facets));
+		}
+	}
+
+
+	/**
+	 * @return Controller
+	 */
+	protected function getController()
+	{
+		return ($this->owner instanceof Controller) ? $this->owner : Controller::curr();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getFacetSpec()
+	{
+		$spec = Config::inst()->get('FacetedCategory', 'facets');
+		return (empty($spec) || !is_array($spec)) ? array() : $spec;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getFilters()
+	{
+		$qs_f       = Config::inst()->get('ShopSearch', 'qs_filters');
+		if (!$qs_f) {
+			return array();
+		}
+		$request    = $this->getController()->getRequest();
+		$filters    = $request->requestVar($qs_f);
+		if (empty($filters) || !is_array($filters)) {
+			return array();
+		}
+		return FacetHelper::inst()->scrubFilters($filters);
+	}
+
+
+	/**
+	 * @param bool $recursive
+	 * @return mixed
+	 */
+	public function FilteredProducts($recursive=true)
+	{
+		if (!isset($this->_filteredProducts)) {
+			$fn = Config::inst()->get('FacetedCategory', 'products_method');
+			if (empty($fn)) {
+				$fn = 'ProductsShowable';
+			}
+			$this->_filteredProducts = $this->owner->$fn($recursive);
+			$this->_filteredProducts = FacetHelper::inst()->addFiltersToDataList($this->_filteredProducts, $this->getFilters());
+		}
+
+		return $this->_filteredProducts;
+	}
+
+	protected $_filteredProducts;
+
+
+	/**
+	 * @return array
+	 */
+	public function getDisabledFacetsArray()
+	{
+		if (empty($this->owner->DisabledFacets)) {
+			return array();
+		}
+		return explode(',', $this->owner->DisabledFacets);
+	}
+
+
+	/**
+	 * @return ArrayList
+	 */
+	public function Facets()
+	{
+		$spec       = $this->getFacetSpec();
+		if (empty($spec)) {
+			return new ArrayList;
+		}
+
+		// remove any disabled facets
+		foreach ($this->getDisabledFacetsArray() as $disabled) {
+			if (isset($spec[$disabled])) {
+				unset($spec[$disabled]);
+			}
+		}
+
+		$request    = $this->getController()->getRequest();
+		$baseLink   = $request->getURL(false);
+		$filters    = $this->getFilters();
+		$baseParams = array_merge($request->requestVars(), array());
+		unset($baseParams['url']);
+
+		$products   = $this->owner->hasMethod('ProductsForFaceting') ? $this->owner->ProductsForFaceting() : $this->FilteredProducts();
+		$facets     = FacetHelper::inst()->buildFacets($products, $spec, (bool)Config::inst()->get('FacetedCategory', 'auto_facet_attributes'));
+		$facets     = FacetHelper::inst()->transformHierarchies($facets);
+		$facets     = FacetHelper::inst()->updateFacetState($facets, $filters);
+		$facets     = FacetHelper::inst()->insertFacetLinks($facets, $baseParams, $baseLink);
+
+		return $facets;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
      */
     protected function getFilters()
     {
-        $qs_f       = Config::inst()->get('ShopSearch', 'qs_filters');
+        $qs_f = Config::inst()->get('ShopSearch', 'qs_filters');
         if (!$qs_f) {
             return array();
         }
@@ -90,7 +90,7 @@ 
      * @param bool $recursive
      * @return mixed
      */
-    public function FilteredProducts($recursive=true)
+    public function FilteredProducts($recursive = true)
     {
         if (!isset($this->_filteredProducts)) {
             $fn = Config::inst()->get('FacetedCategory', 'products_method');
@@ -124,7 +124,7 @@ 
      */
     public function Facets()
     {
-        $spec       = $this->getFacetSpec();
+        $spec = $this->getFacetSpec();
         if (empty($spec)) {
             return new ArrayList;
         }

code/helpers/ProductCategoryHelperMethods.php

Indentation +132 added lines, -132 removed lines

@@ -11,136 +11,136 @@
  */
 class ProductCategoryHelperMethods extends DataExtension
 {
-    /**
-     * Includes Parent() and ProductCategories() and all the parent categories of each.
-     * @param bool $recursive [optional] - include the parents of the categories as well? - default: true
-     * @return array - array of productCategory records
-     */
-    protected function buildParentCategoriesArray($recursive=true)
-    {
-        $out = array();
-
-        // add the main parent
-        $parent = $this->owner->Parent();
-        if (!$parent || !$parent->exists()) {
-            return $out;
-        }
-        if ($parent->ClassName == 'ProductCategory') {
-            $out[$parent->ID] = $parent;
-        }
-
-        if ($recursive) {
-            foreach ($parent->getAncestors() as $rec) {
-                if ($rec->ClassName == 'ProductCategory') {
-                    $out[$rec->ID] = $rec;
-                }
-            }
-        }
-
-        // add any secondary categories
-        foreach ($this->owner->ProductCategories() as $cat) {
-            $out[$cat->ID] = $cat;
-            if ($recursive) {
-                foreach ($cat->getAncestors() as $rec) {
-                    if ($rec->ClassName == 'ProductCategory') {
-                        $out[$rec->ID] = $rec;
-                    }
-                }
-            }
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * Includes Parent() and ProductCategories() and all the parent categories of each.
-     * @return ArrayList - array of productCategory records
-     */
-    public function getAllCategories()
-    {
-        return new ArrayList($this->buildParentCategoriesArray(false));
-    }
-
-
-    /**
-     * Includes Parent() and ProductCategories() and all the parent categories of each.
-     * @return ArrayList - array of productCategory records
-     */
-    public function getAllCategoriesRecursive()
-    {
-        return new ArrayList($this->buildParentCategoriesArray(true));
-    }
-
-
-    /**
-     * Includes Parent() and ProductCategories()
-     * @return array - array of ID's
-     */
-    public function getAllCategoryIDs()
-    {
-        return array_keys($this->buildParentCategoriesArray(false));
-    }
-
-
-    /**
-     * Includes Parent() and ProductCategories() and all the parent categories of each.
-     * @return array - array of ID's
-     */
-    public function getAllCategoryIDsRecursive()
-    {
-        return array_keys($this->buildParentCategoriesArray(true));
-    }
-
-
-    /**
-     * Returns an array of the titles of all the categories.
-     * @return array - (strings)
-     */
-    public function getAllCategoryTitles()
-    {
-        $cats = $this->buildParentCategoriesArray(false);
-        $out = array();
-        foreach ($cats as $cat) {
-            $out[] = $cat->Title;
-        }
-        return $out;
-    }
-
-
-    /**
-     * Returns an array of the titles of all the categories, including grandparents, etc
-     * @return array - (strings)
-     */
-    public function getAllCategoryTitlesRecursive()
-    {
-        $cats = $this->buildParentCategoriesArray(true);
-        $out = array();
-        foreach ($cats as $cat) {
-            $out[] = $cat->Title;
-        }
-        return $out;
-    }
-
-
-    /**
-     * Returns a string of the titles of all the categories.
-     * @param string $sep
-     * @return string
-     */
-    public function getJoinedCategoryTitles($sep = ', ')
-    {
-        return implode($sep, $this->getAllCategoryTitles());
-    }
-
-
-    /**
-     * Returns a string of the titles of all the categories.
-     * @param string $sep
-     * @return string
-     */
-    public function getJoinedCategoryTitlesRecursive($sep = ', ')
-    {
-        return implode($sep, $this->getAllCategoryTitlesRecursive());
-    }
+	/**
+	 * Includes Parent() and ProductCategories() and all the parent categories of each.
+	 * @param bool $recursive [optional] - include the parents of the categories as well? - default: true
+	 * @return array - array of productCategory records
+	 */
+	protected function buildParentCategoriesArray($recursive=true)
+	{
+		$out = array();
+
+		// add the main parent
+		$parent = $this->owner->Parent();
+		if (!$parent || !$parent->exists()) {
+			return $out;
+		}
+		if ($parent->ClassName == 'ProductCategory') {
+			$out[$parent->ID] = $parent;
+		}
+
+		if ($recursive) {
+			foreach ($parent->getAncestors() as $rec) {
+				if ($rec->ClassName == 'ProductCategory') {
+					$out[$rec->ID] = $rec;
+				}
+			}
+		}
+
+		// add any secondary categories
+		foreach ($this->owner->ProductCategories() as $cat) {
+			$out[$cat->ID] = $cat;
+			if ($recursive) {
+				foreach ($cat->getAncestors() as $rec) {
+					if ($rec->ClassName == 'ProductCategory') {
+						$out[$rec->ID] = $rec;
+					}
+				}
+			}
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * Includes Parent() and ProductCategories() and all the parent categories of each.
+	 * @return ArrayList - array of productCategory records
+	 */
+	public function getAllCategories()
+	{
+		return new ArrayList($this->buildParentCategoriesArray(false));
+	}
+
+
+	/**
+	 * Includes Parent() and ProductCategories() and all the parent categories of each.
+	 * @return ArrayList - array of productCategory records
+	 */
+	public function getAllCategoriesRecursive()
+	{
+		return new ArrayList($this->buildParentCategoriesArray(true));
+	}
+
+
+	/**
+	 * Includes Parent() and ProductCategories()
+	 * @return array - array of ID's
+	 */
+	public function getAllCategoryIDs()
+	{
+		return array_keys($this->buildParentCategoriesArray(false));
+	}
+
+
+	/**
+	 * Includes Parent() and ProductCategories() and all the parent categories of each.
+	 * @return array - array of ID's
+	 */
+	public function getAllCategoryIDsRecursive()
+	{
+		return array_keys($this->buildParentCategoriesArray(true));
+	}
+
+
+	/**
+	 * Returns an array of the titles of all the categories.
+	 * @return array - (strings)
+	 */
+	public function getAllCategoryTitles()
+	{
+		$cats = $this->buildParentCategoriesArray(false);
+		$out = array();
+		foreach ($cats as $cat) {
+			$out[] = $cat->Title;
+		}
+		return $out;
+	}
+
+
+	/**
+	 * Returns an array of the titles of all the categories, including grandparents, etc
+	 * @return array - (strings)
+	 */
+	public function getAllCategoryTitlesRecursive()
+	{
+		$cats = $this->buildParentCategoriesArray(true);
+		$out = array();
+		foreach ($cats as $cat) {
+			$out[] = $cat->Title;
+		}
+		return $out;
+	}
+
+
+	/**
+	 * Returns a string of the titles of all the categories.
+	 * @param string $sep
+	 * @return string
+	 */
+	public function getJoinedCategoryTitles($sep = ', ')
+	{
+		return implode($sep, $this->getAllCategoryTitles());
+	}
+
+
+	/**
+	 * Returns a string of the titles of all the categories.
+	 * @param string $sep
+	 * @return string
+	 */
+	public function getJoinedCategoryTitlesRecursive($sep = ', ')
+	{
+		return implode($sep, $this->getAllCategoryTitlesRecursive());
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
      * @param bool $recursive [optional] - include the parents of the categories as well? - default: true
      * @return array - array of productCategory records
      */
-    protected function buildParentCategoriesArray($recursive=true)
+    protected function buildParentCategoriesArray($recursive = true)
     {
         $out = array();
 

code/helpers/VirtualFieldIndexQueuedJob.php

Indentation +51 added lines, -51 removed lines

@@ -1,69 +1,69 @@
 <?php
 /**
- * If the queued jobs module is installed, this will be used instead of
- * updating vfi's in onBeforeWrite.
- *
- * @author  Mark Guinn <mark@adaircreative.com>
- * @date    07.02.2015
- * @package shop_search
- * @subpackage helpers
- */
+	 * If the queued jobs module is installed, this will be used instead of
+	 * updating vfi's in onBeforeWrite.
+	 *
+	 * @author  Mark Guinn <mark@adaircreative.com>
+	 * @date    07.02.2015
+	 * @package shop_search
+	 * @subpackage helpers
+	 */
 if (!interface_exists('QueuedJob')) {
-    return;
+	return;
 }
 
 class VirtualFieldIndexQueuedJob extends AbstractQueuedJob implements QueuedJob
 {
-    /**
-     * The QueuedJob queue to use when processing updates
-     * @config
-     * @var int
-     */
-    private static $reindex_queue = 2; // QueuedJob::QUEUED;
+	/**
+	 * The QueuedJob queue to use when processing updates
+	 * @config
+	 * @var int
+	 */
+	private static $reindex_queue = 2; // QueuedJob::QUEUED;
 
 
-    /**
-     * @param DataObject $object
-     * @param array $fields
-     */
-    public function __construct($object, array $fields)
-    {
-        $this->setObject($object);
-        $this->rebuildFields = $fields;
-    }
+	/**
+	 * @param DataObject $object
+	 * @param array $fields
+	 */
+	public function __construct($object, array $fields)
+	{
+		$this->setObject($object);
+		$this->rebuildFields = $fields;
+	}
 
 
-    /**
-     * Helper method
-     */
-    public function triggerProcessing()
-    {
-        singleton('QueuedJobService')->queueJob($this);
-    }
+	/**
+	 * Helper method
+	 */
+	public function triggerProcessing()
+	{
+		singleton('QueuedJobService')->queueJob($this);
+	}
 
 
-    /**
-     * @return string
-     */
-    public function getTitle()
-    {
-        $obj = $this->getObject();
-        return "Update Virtual Field Indexes: " . ($obj ? $obj->getTitle() : '???');
-    }
+	/**
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		$obj = $this->getObject();
+		return "Update Virtual Field Indexes: " . ($obj ? $obj->getTitle() : '???');
+	}
 
 
-    /**
-     * Reprocess any needed fields
-     */
-    public function process()
-    {
-        Versioned::reading_stage('Stage');
-        $obj = $this->getObject();
+	/**
+	 * Reprocess any needed fields
+	 */
+	public function process()
+	{
+		Versioned::reading_stage('Stage');
+		$obj = $this->getObject();
 
-        if ($obj) {
-            $obj->rebuildVFI();
-        }
+		if ($obj) {
+			$obj->rebuildVFI();
+		}
 
-        $this->isComplete = true;
-    }
+		$this->isComplete = true;
+	}
 }

code/reports/SearchTermsReport.php

Indentation +36 added lines, -36 removed lines

@@ -1,43 +1,43 @@
 <?php
 /**
- * Silverstripe report for searchs
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 09.24.2014
- * @package apluswhs.com
- * @subpackage
- */
+	 * Silverstripe report for searchs
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 09.24.2014
+	 * @package apluswhs.com
+	 * @subpackage
+	 */
 class SearchTermsReport extends ShopPeriodReport
 {
-    protected $title = "Search Terms";
-    protected $description = "Understand what users are searching for.";
-    protected $dataClass = "SearchLog";
-    protected $periodfield = "SearchLog.Created";
+	protected $title = "Search Terms";
+	protected $description = "Understand what users are searching for.";
+	protected $dataClass = "SearchLog";
+	protected $periodfield = "SearchLog.Created";
 
-    public function columns()
-    {
-        return array(
-            "Query" => array(
-                "title" => "Query",
-                "formatting" => '<a href=\"home/SearchForm?q=$ATT_val($Query)\" target=\"_new\">$Query</a>'
-            ),
-            'NumResults' => 'Results',
-            'Quantity' => 'Searches',
-            'MostRecent' => 'Most Recent',
-        );
-    }
+	public function columns()
+	{
+		return array(
+			"Query" => array(
+				"title" => "Query",
+				"formatting" => '<a href=\"home/SearchForm?q=$ATT_val($Query)\" target=\"_new\">$Query</a>'
+			),
+			'NumResults' => 'Results',
+			'Quantity' => 'Searches',
+			'MostRecent' => 'Most Recent',
+		);
+	}
 
-    public function query($params)
-    {
-        $query = parent::query($params);
-        $query->selectField($this->periodfield, "FilterPeriod")
-            ->addSelect("SearchLog.Query")
-            ->selectField("Count(SearchLog.ID)", "Quantity")
-            ->selectField("Max(SearchLog.Created)", "MostRecent")
-            ->selectField("Max(SearchLog.NumResults)", "NumResults");
-        $query->addGroupby("SearchLog.Query");
-        $query->addWhere("\"SearchLog\".\"Filters\" is null AND \"SearchLog\".\"ParentSearchID\" = '0'");
-        $query->setOrderBy("Quantity", "DESC");
-        return $query;
-    }
+	public function query($params)
+	{
+		$query = parent::query($params);
+		$query->selectField($this->periodfield, "FilterPeriod")
+			->addSelect("SearchLog.Query")
+			->selectField("Count(SearchLog.ID)", "Quantity")
+			->selectField("Max(SearchLog.Created)", "MostRecent")
+			->selectField("Max(SearchLog.NumResults)", "NumResults");
+		$query->addGroupby("SearchLog.Query");
+		$query->addWhere("\"SearchLog\".\"Filters\" is null AND \"SearchLog\".\"ParentSearchID\" = '0'");
+		$query->setOrderBy("Quantity", "DESC");
+		return $query;
+	}
 }