markguinn / silverstripe-shop-search

tasks/BuildVFI.php

Braces +22 added lines, -9 removed lines

@@ -27,8 +27,12 @@ 
 			$count  = $list->count();
 			for ($i = $n; $i < $count; $i += 10) {
 				$chunk = $list->limit(10, $i);
-				if (Controller::curr() instanceof TaskRunner) echo "Processing VFI #$i...\n";
-				foreach ($chunk as $rec) $rec->rebuildVFI();
+				if (Controller::curr() instanceof TaskRunner) {
+					echo "Processing VFI #$i...\n";
+				}
+				foreach ($chunk as $rec) {
+					$rec->rebuildVFI();
+				}
 			}
 			VirtualFieldIndex::build($c);
 
@@ -58,7 +62,9 @@ 
 
 		if (isset($_GET['class']) && isset($_GET['id'])) {
 			$item = DataObject::get($_GET['class'])->byID($_GET['id']);
-			if (!$item || !$item->exists()) die('not found: ' . $_GET['id']);
+			if (!$item || !$item->exists()) {
+				die('not found: ' . $_GET['id']);
+			}
 			$item->rebuildVFI();
 			echo "done";
 			return;
@@ -66,7 +72,9 @@ 
 
 		if (isset($_GET['link'])) {
 			$item = SiteTree::get_by_link($_GET['link']);
-			if (!$item || !$item->exists()) die('not found: ' . $_GET['link']);
+			if (!$item || !$item->exists()) {
+				die('not found: ' . $_GET['link']);
+			}
 			$item->rebuildVFI();
 			echo "done";
 			return;
@@ -74,8 +82,7 @@ 
 
 		if (isset($_GET['start'])) {
 			$this->runFrom($_GET['class'], $_GET['start'], $_GET['field']);
-		}
-		else {
+		} else {
 			foreach(array('framework','sapphire') as $dirname) {
 				$script = sprintf("%s%s$dirname%scli-script.php", BASE_PATH, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR);
 				if(file_exists($script)) {
@@ -85,7 +92,9 @@ 
 
 			$classes = VirtualFieldIndex::get_classes_with_vfi();
 			foreach ($classes as $class) {
-				if (isset($_GET['class']) && $class != $_GET['class']) continue;
+				if (isset($_GET['class']) && $class != $_GET['class']) {
+					continue;
+				}
 				$singleton = singleton($class);
 				$query = $singleton->get($class);
 				$dtaQuery = $query->dataQuery();
@@ -100,9 +109,13 @@ 
 				for ($offset = $startFrom; $offset < $total; $offset += $this->stat('recordsPerRequest')) {
 					echo "$offset..";
 					$cmd = "php $script dev/tasks/$self class=$class start=$offset field=$field";
-					if($verbose) echo "\n  Running '$cmd'\n";
+					if($verbose) {
+						echo "\n  Running '$cmd'\n";
+					}
 					$res = $verbose ? passthru($cmd) : `$cmd`;
-					if($verbose) echo "  ".preg_replace('/\r\n|\n/', '$0  ', $res)."\n";
+					if($verbose) {
+						echo "  ".preg_replace('/\r\n|\n/', '$0  ', $res)."\n";
+					}
 				}
 			}
 		}

Spacing +7 added lines, -7 removed lines

@@ -58,7 +58,7 @@ 
 
 		if (isset($_GET['class']) && isset($_GET['id'])) {
 			$item = DataObject::get($_GET['class'])->byID($_GET['id']);
-			if (!$item || !$item->exists()) die('not found: ' . $_GET['id']);
+			if (!$item || !$item->exists()) die('not found: '.$_GET['id']);
 			$item->rebuildVFI();
 			echo "done";
 			return;
@@ -66,7 +66,7 @@ 
 
 		if (isset($_GET['link'])) {
 			$item = SiteTree::get_by_link($_GET['link']);
-			if (!$item || !$item->exists()) die('not found: ' . $_GET['link']);
+			if (!$item || !$item->exists()) die('not found: '.$_GET['link']);
 			$item->rebuildVFI();
 			echo "done";
 			return;
@@ -76,9 +76,9 @@ 
 			$this->runFrom($_GET['class'], $_GET['start'], $_GET['field']);
 		}
 		else {
-			foreach(array('framework','sapphire') as $dirname) {
+			foreach (array('framework', 'sapphire') as $dirname) {
 				$script = sprintf("%s%s$dirname%scli-script.php", BASE_PATH, DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR);
-				if(file_exists($script)) {
+				if (file_exists($script)) {
 					break;
 				}
 			}
@@ -90,7 +90,7 @@ 
 				$query = $singleton->get($class);
 				$dtaQuery = $query->dataQuery();
 				$sqlQuery = $dtaQuery->getFinalisedQuery();
-				$singleton->extend('augmentSQL',$sqlQuery,$dtaQuery);
+				$singleton->extend('augmentSQL', $sqlQuery, $dtaQuery);
 				$total = $query->count();
 				$startFrom = isset($_GET['startfrom']) ? $_GET['startfrom'] : 0;
 				$field = isset($_GET['field']) ? $_GET['field'] : '';
@@ -100,9 +100,9 @@ 
 				for ($offset = $startFrom; $offset < $total; $offset += $this->stat('recordsPerRequest')) {
 					echo "$offset..";
 					$cmd = "php $script dev/tasks/$self class=$class start=$offset field=$field";
-					if($verbose) echo "\n  Running '$cmd'\n";
+					if ($verbose) echo "\n  Running '$cmd'\n";
 					$res = $verbose ? passthru($cmd) : `$cmd`;
-					if($verbose) echo "  ".preg_replace('/\r\n|\n/', '$0  ', $res)."\n";
+					if ($verbose) echo "  ".preg_replace('/\r\n|\n/', '$0  ', $res)."\n";
 				}
 			}
 		}

code/helpers/FacetHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -368,7 +368,7 @@ 
 
     /**
      * NOTE: this will break if applied to something that's not a SiteTree subclass.
-     * @param DataList|PaginatedList $matches
+     * @param SS_List $matches
      * @param array $facet
      * @param int $typeID
      */
@@ -408,7 +408,7 @@ 
 
     /**
      * Builds facets from all attributes present in the data set.
-     * @param DataList|PaginatedList $matches
+     * @param SS_List $matches
      * @return array
      */
     protected function buildAllAttributeFacets($matches)

Spacing +16 added lines, -16 removed lines

@@ -67,7 +67,7 @@ 
      * @param DataObject|string $sing - just a singleton object we can get information off of
      * @return DataList
      */
-    public function addFiltersToDataList($list, array $filters, $sing=null)
+    public function addFiltersToDataList($list, array $filters, $sing = null)
     {
         if (!$sing) {
             $sing = singleton($list->dataClass());
@@ -117,14 +117,14 @@ 
         if ($rec->hasExtension('VirtualFieldIndex') && ($spec = $rec->getVFISpec($filterField))) {
             if ($spec['Type'] == VirtualFieldIndex::TYPE_LIST) {
                 // Lists have to be handled a little differently
-                $f = $rec->getVFIFieldName($filterField) . ':PartialMatch';
+                $f = $rec->getVFIFieldName($filterField).':PartialMatch';
                 if (is_array($filterVal)) {
                     foreach ($filterVal as &$val) {
-                        $val = '|' . $val . '|';
+                        $val = '|'.$val.'|';
                     }
                     return array($f => $filterVal);
                 } else {
-                    return array($f => '|' . $filterVal . '|');
+                    return array($f => '|'.$filterVal.'|');
                 }
             } else {
                 // Simples are simple
@@ -170,7 +170,7 @@ 
                 $facets[$field]['Source'] = $field;
             }
             if (empty($facets[$field]['Type'])) {
-                $facets[$field]['Type']  = ShopSearch::FACET_TYPE_LINK;
+                $facets[$field]['Type'] = ShopSearch::FACET_TYPE_LINK;
             }
 
             if (empty($facets[$field]['Values'])) {
@@ -178,7 +178,7 @@ 
             } else {
                 $vals = $facets[$field]['Values'];
                 if (is_string($vals)) {
-                    $vals = eval('return ' . $vals . ';');
+                    $vals = eval('return '.$vals.';');
                 }
                 $facets[$field]['Values'] = array();
                 foreach ($vals as $val => $lbl) {
@@ -222,7 +222,7 @@ 
      * @param bool $autoFacetAttributes [optional]
      * @return ArrayList
      */
-    public function buildFacets(SS_List $matches, array $facetSpec, $autoFacetAttributes=false)
+    public function buildFacets(SS_List $matches, array $facetSpec, $autoFacetAttributes = false)
     {
         $facets = $this->expandFacetSpec($facetSpec);
         if (!$autoFacetAttributes && (empty($facets) || !$matches || !$matches->count())) {
@@ -401,7 +401,7 @@ 
 
         $facet['Values'] = array();
         foreach ($q as $row) {
-            $facet['Values'][ $row['Value'] ] = new ArrayData($row);
+            $facet['Values'][$row['Value']] = new ArrayData($row);
         }
     }
 
@@ -461,7 +461,7 @@ 
 
             unset($row['TypeID']);
             unset($row['TypeLabel']);
-            $curFacet['Values'][ $row['Value'] ] = new ArrayData($row);
+            $curFacet['Values'][$row['Value']] = new ArrayData($row);
         }
 
         if ($curType > 0) {
@@ -493,8 +493,8 @@ 
                         $params[$qs_f] = array();
                     }
                     $params[$qs_f][$facet->Source] = 'RANGEFACETVALUE';
-                    $params[$qs_t] = $facet->Label . ': RANGEFACETLABEL';
-                    $facet->Link = $baseLink . '?' . http_build_query($params);
+                    $params[$qs_t] = $facet->Label.': RANGEFACETLABEL';
+                    $facet->Link = $baseLink.'?'.http_build_query($params);
                 break;
 
                 case ShopSearch::FACET_TYPE_CHECKBOX;
@@ -517,14 +517,14 @@ 
                         }
                         if ($facet->Type == ShopSearch::FACET_TYPE_CHECKBOX) {
                             unset($params[$qs_f][$facet->Source]); // this will be figured out via javascript
-                            $params[$qs_t] = ($value->Active ? 'Remove ' : '') . $facet->Label . ': ' . $value->Label;
+                            $params[$qs_t] = ($value->Active ? 'Remove ' : '').$facet->Label.': '.$value->Label;
                         } else {
                             $params[$qs_f][$facet->Source] = $value->Value;
-                            $params[$qs_t] = $facet->Label . ': ' . $value->Label;
+                            $params[$qs_t] = $facet->Label.': '.$value->Label;
                         }
 
                         // build a new link
-                        $value->Link = $baseLink . '?' . http_build_query($params);
+                        $value->Link = $baseLink.'?'.http_build_query($params);
                     }
             }
         }
@@ -599,7 +599,7 @@ 
      * @param bool      $filterOnlyLeaves [optional]
      * @return bool - true if any of the children are true, false if all children are false
      */
-    protected function updateCheckboxFacetState(ArrayList $values, array $filterVals, $filterOnlyLeaves=false)
+    protected function updateCheckboxFacetState(ArrayList $values, array $filterVals, $filterOnlyLeaves = false)
     {
         $out = false;
 
@@ -651,7 +651,7 @@ 
 
                     // Look for the most recent parent that matches the beginning of this one
                     while (count($parentStack) > 0) {
-                        $curParent = $parentStack[ count($parentStack)-1 ];
+                        $curParent = $parentStack[count($parentStack) - 1];
                         if (strpos($value->Label, $curParent->FullLabel) === 0) {
                             if (!isset($curParent->Children)) {
                                 $curParent->Children = new ArrayList();

Indentation +670 added lines, -670 removed lines

@@ -13,679 +13,679 @@
  */
 class FacetHelper extends Object
 {
-    /** @var bool - if this is turned on it will use an algorithm that doesn't require traversing the data set if possible */
-    private static $faster_faceting = false;
-
-    /** @var bool - should the facets (link and checkbox only) be sorted - this can mess with things like category lists */
-    private static $sort_facet_values = true;
-
-    /** @var string - I don't know why you'd want to override this, but you could if you wanted */
-    private static $attribute_facet_regex = '/^ATT(\d+)$/';
-
-    /** @var bool - For checkbox facets, is the initial state all checked or all unchecked? */
-    private static $default_checkbox_state = true;
-
-
-    /**
-     * @return FacetHelper
-     */
-    public static function inst()
-    {
-        return Injector::inst()->get('FacetHelper');
-    }
-
-
-    /**
-     * Performs some quick pre-processing on filters from any source
-     *
-     * @param array $filters
-     * @return array
-     */
-    public function scrubFilters($filters)
-    {
-        if (!is_array($filters)) {
-            $filters = array();
-        }
-
-        foreach ($filters as $k => $v) {
-            if (empty($v)) {
-                unset($filters[$k]);
-            }
-            // this allows you to send an array as a comma-separated list, which is easier on the query string length
-            if (is_string($v) && strpos($v, 'LIST~') === 0) {
-                $filters[$k] = explode(',', substr($v, 5));
-            }
-        }
-
-        return $filters;
-    }
-
-
-    /**
-     * @param DataList $list
-     * @param array    $filters
-     * @param DataObject|string $sing - just a singleton object we can get information off of
-     * @return DataList
-     */
-    public function addFiltersToDataList($list, array $filters, $sing=null)
-    {
-        if (!$sing) {
-            $sing = singleton($list->dataClass());
-        }
-        if (is_string($sing)) {
-            $sing = singleton($sing);
-        }
-
-        if (!empty($filters)) {
-            foreach ($filters as $filterField => $filterVal) {
-                if ($sing->hasExtension('HasStaticAttributes') && preg_match(self::config()->attribute_facet_regex, $filterField, $matches)) {
-                    //					$sav = $sing->StaticAttributeValues();
+	/** @var bool - if this is turned on it will use an algorithm that doesn't require traversing the data set if possible */
+	private static $faster_faceting = false;
+
+	/** @var bool - should the facets (link and checkbox only) be sorted - this can mess with things like category lists */
+	private static $sort_facet_values = true;
+
+	/** @var string - I don't know why you'd want to override this, but you could if you wanted */
+	private static $attribute_facet_regex = '/^ATT(\d+)$/';
+
+	/** @var bool - For checkbox facets, is the initial state all checked or all unchecked? */
+	private static $default_checkbox_state = true;
+
+
+	/**
+	 * @return FacetHelper
+	 */
+	public static function inst()
+	{
+		return Injector::inst()->get('FacetHelper');
+	}
+
+
+	/**
+	 * Performs some quick pre-processing on filters from any source
+	 *
+	 * @param array $filters
+	 * @return array
+	 */
+	public function scrubFilters($filters)
+	{
+		if (!is_array($filters)) {
+			$filters = array();
+		}
+
+		foreach ($filters as $k => $v) {
+			if (empty($v)) {
+				unset($filters[$k]);
+			}
+			// this allows you to send an array as a comma-separated list, which is easier on the query string length
+			if (is_string($v) && strpos($v, 'LIST~') === 0) {
+				$filters[$k] = explode(',', substr($v, 5));
+			}
+		}
+
+		return $filters;
+	}
+
+
+	/**
+	 * @param DataList $list
+	 * @param array    $filters
+	 * @param DataObject|string $sing - just a singleton object we can get information off of
+	 * @return DataList
+	 */
+	public function addFiltersToDataList($list, array $filters, $sing=null)
+	{
+		if (!$sing) {
+			$sing = singleton($list->dataClass());
+		}
+		if (is_string($sing)) {
+			$sing = singleton($sing);
+		}
+
+		if (!empty($filters)) {
+			foreach ($filters as $filterField => $filterVal) {
+				if ($sing->hasExtension('HasStaticAttributes') && preg_match(self::config()->attribute_facet_regex, $filterField, $matches)) {
+					//					$sav = $sing->StaticAttributeValues();
 //					Debug::log("sav = {$sav->getJoinTable()}, {$sav->getLocalKey()}, {$sav->getForeignKey()}");
 //					$list = $list
 //						->innerJoin($sav->getJoinTable(), "\"{$sing->baseTable()}\".\"ID\" = \"{$sav->getJoinTable()}\".\"{$sav->getLocalKey()}\"")
 //						->filter("\"{$sav->getJoinTable()}\".\"{$sav->getForeignKey()}\"", $filterVal)
 //					;
-                    // TODO: This logic should be something like the above, but I don't know
-                    // how to get the join table from a singleton (which returns an UnsavedRelationList
-                    // instead of a ManyManyList). I've got a deadline to meet, though, so this
-                    // will catch the majority of cases as long as the extension is applied to the
-                    // Product class instead of a subclass.
-                    $list = $list
-                        ->innerJoin('Product_StaticAttributeTypes', "\"SiteTree\".\"ID\" = \"Product_StaticAttributeTypes\".\"ProductID\"")
-                        ->innerJoin('ProductAttributeValue', "\"Product_StaticAttributeTypes\".\"ProductAttributeTypeID\" = \"ProductAttributeValue\".\"TypeID\"")
-                        ->innerJoin('Product_StaticAttributeValues', "\"SiteTree\".\"ID\" = \"Product_StaticAttributeValues\".\"ProductID\" AND \"ProductAttributeValue\".\"ID\" = \"Product_StaticAttributeValues\".\"ProductAttributeValueID\"")
-                        ->filter("Product_StaticAttributeValues.ProductAttributeValueID", $filterVal);
-                } else {
-                    $list = $list->filter($this->processFilterField($sing, $filterField, $filterVal));
-                }
-            }
-        }
-
-        return $list;
-    }
-
-
-    /**
-     * @param DataObject $rec           This would normally just be a singleton but we don't want to have to create it over and over
-     * @param string     $filterField
-     * @param mixed      $filterVal
-     * @return array - returns the new filter added
-     */
-    public function processFilterField($rec, $filterField, $filterVal)
-    {
-        // First check for VFI fields
-        if ($rec->hasExtension('VirtualFieldIndex') && ($spec = $rec->getVFISpec($filterField))) {
-            if ($spec['Type'] == VirtualFieldIndex::TYPE_LIST) {
-                // Lists have to be handled a little differently
-                $f = $rec->getVFIFieldName($filterField) . ':PartialMatch';
-                if (is_array($filterVal)) {
-                    foreach ($filterVal as &$val) {
-                        $val = '|' . $val . '|';
-                    }
-                    return array($f => $filterVal);
-                } else {
-                    return array($f => '|' . $filterVal . '|');
-                }
-            } else {
-                // Simples are simple
-                $filterField = $rec->getVFIFieldName($filterField);
-            }
-        }
-
-        // Next check for regular db fields
-        if ($rec->dbObject($filterField)) {
-            // Is it a range value?
-            if (is_string($filterVal) && preg_match('/^RANGE\~(.+)\~(.+)$/', $filterVal, $m)) {
-                $filterField .= ':Between';
-                $filterVal = array_slice($m, 1, 2);
-            }
-
-            return array($filterField => $filterVal);
-        }
-
-        return array();
-    }
-
-
-    /**
-     * Processes the facet spec and removes any shorthand (field => label).
-     * @param array $facetSpec
-     * @return array
-     */
-    public function expandFacetSpec(array $facetSpec)
-    {
-        if (is_null($facetSpec)) {
-            return array();
-        }
-        $facets = array();
-
-        foreach ($facetSpec as $field => $label) {
-            if (is_array($label)) {
-                $facets[$field] = $label;
-            } else {
-                $facets[$field] = array('Label' => $label);
-            }
-
-            if (empty($facets[$field]['Source'])) {
-                $facets[$field]['Source'] = $field;
-            }
-            if (empty($facets[$field]['Type'])) {
-                $facets[$field]['Type']  = ShopSearch::FACET_TYPE_LINK;
-            }
-
-            if (empty($facets[$field]['Values'])) {
-                $facets[$field]['Values'] = array();
-            } else {
-                $vals = $facets[$field]['Values'];
-                if (is_string($vals)) {
-                    $vals = eval('return ' . $vals . ';');
-                }
-                $facets[$field]['Values'] = array();
-                foreach ($vals as $val => $lbl) {
-                    $facets[$field]['Values'][$val] = new ArrayData(array(
-                        'Label'     => $lbl,
-                        'Value'     => $val,
-                        'Count'     => 0,
-                    ));
-                }
-            }
-        }
-
-        return $facets;
-    }
-
-
-    /**
-     * This is super-slow. I'm assuming if you're using facets you
-     * probably also ought to be using Solr or something else. Or
-     * maybe you have unlimited time and can refactor this feature
-     * and submit a pull request...
-     *
-     * TODO: If this is going to be used for categories we're going
-     * to have to really clean it up and speed it up.
-     * Suggestion:
-     *  - option to turn off counts
-     *  - switch order of nested array so we don't go through results unless needed
-     *  - if not doing counts, min/max and link facets can be handled w/ queries
-     *  - separate that bit out into a new function
-     * NOTE: This is partially done with the "faster_faceting" config
-     * option but more could be done, particularly by covering link facets as well.
-     *
-     * Output - list of ArrayData in the format:
-     *   Label - name of the facet
-     *   Source - field name of the facet
-     *   Type - one of the ShopSearch::FACET_TYPE_XXXX constants
-     *   Values - SS_List of possible values for this facet
-     *
-     * @param SS_List $matches
-     * @param array $facetSpec
-     * @param bool $autoFacetAttributes [optional]
-     * @return ArrayList
-     */
-    public function buildFacets(SS_List $matches, array $facetSpec, $autoFacetAttributes=false)
-    {
-        $facets = $this->expandFacetSpec($facetSpec);
-        if (!$autoFacetAttributes && (empty($facets) || !$matches)) {
-            return new ArrayList();
-        }
-        $fasterMethod = (bool)$this->config()->faster_faceting;
-
-        // fill them in
-        foreach ($facets as $field => &$facet) {
-            if (preg_match(self::config()->attribute_facet_regex, $field, $m)) {
-                $this->buildAttributeFacet($matches, $facet, $m[1]);
-                continue;
-            }
-
-            // NOTE: using this method range and checkbox facets don't get counts
-            if ($fasterMethod && $facet['Type'] != ShopSearch::FACET_TYPE_LINK) {
-                if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
-                    if (isset($facet['RangeMin'])) {
-                        $facet['MinValue'] = $facet['RangeMin'];
-                    }
-                    if (isset($facet['RangeMax'])) {
-                        $facet['MaxValue'] = $facet['RangeMax'];
-                    }
-                }
-
-                continue;
-            }
-
-            foreach ($matches as $rec) {
-                // If it's a range facet, set up the min/max
-                if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
-                    if (isset($facet['RangeMin'])) {
-                        $facet['MinValue'] = $facet['RangeMin'];
-                    }
-                    if (isset($facet['RangeMax'])) {
-                        $facet['MaxValue'] = $facet['RangeMax'];
-                    }
-                }
-
-                // If the field is accessible via normal methods, including
-                // a user-defined getter, prefer that
-                $fieldValue = $rec->relObject($field);
-                if (is_null($fieldValue) && $rec->hasMethod($meth = "get{$field}")) {
-                    $fieldValue = $rec->$meth();
-                }
-
-                // If not, look for a VFI field
-                if (!$fieldValue && $rec->hasExtension('VirtualFieldIndex')) {
-                    $fieldValue = $rec->getVFI($field);
-                }
-
-                // If we found something, process it
-                if (!empty($fieldValue)) {
-                    // normalize so that it's iterable
-                    if (!is_array($fieldValue) && !$fieldValue instanceof SS_List) {
-                        $fieldValue = array($fieldValue);
-                    }
-
-                    foreach ($fieldValue as $obj) {
-                        if (empty($obj)) {
-                            continue;
-                        }
-
-                        // figure out the right label
-                        if (is_object($obj) && $obj->hasMethod('Nice')) {
-                            $lbl = $obj->Nice();
-                        } elseif (is_object($obj) && !empty($obj->Title)) {
-                            $lbl = $obj->Title;
-                        } elseif (
-                            is_numeric($obj) &&
-                            !empty($facet['LabelFormat']) &&
-                            $facet['LabelFormat'] === 'Currency' &&
-                            $facet['Type'] !== ShopSearch::FACET_TYPE_RANGE // this one handles it via javascript
-                        ) {
-                            $tmp = Currency::create($field);
-                            $tmp->setValue($obj);
-                            $lbl = $tmp->Nice();
-                        } else {
-                            $lbl = (string)$obj;
-                        }
-
-                        // figure out the value for sorting
-                        if (is_object($obj) && $obj->hasMethod('getAmount')) {
-                            $val = $obj->getAmount();
-                        } elseif (is_object($obj) && !empty($obj->ID)) {
-                            $val = $obj->ID;
-                        } else {
-                            $val = (string)$obj;
-                        }
-
-                        // if it's a range facet, calculate the min and max
-                        if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
-                            if (!isset($facet['MinValue']) || $val < $facet['MinValue']) {
-                                $facet['MinValue'] = $val;
-                                $facet['MinLabel'] = $lbl;
-                            }
-                            if (!isset($facet['RangeMin']) || $val < $facet['RangeMin']) {
-                                $facet['RangeMin'] = $val;
-                            }
-                            if (!isset($facet['MaxValue']) || $val > $facet['MaxValue']) {
-                                $facet['MaxValue'] = $val;
-                                $facet['MaxLabel'] = $lbl;
-                            }
-                            if (!isset($facet['RangeMax']) || $val > $facet['RangeMax']) {
-                                $facet['RangeMax'] = $val;
-                            }
-                        }
-
-                        // Tally the value in the facets
-                        if (!isset($facet['Values'][$val])) {
-                            $facet['Values'][$val] = new ArrayData(array(
-                                'Label'     => $lbl,
-                                'Value'     => $val,
-                                'Count'     => 1,
-                            ));
-                        } elseif ($facet['Values'][$val]) {
-                            $facet['Values'][$val]->Count++;
-                        }
-                    }
-                }
-            }
-        }
-
-        // if we're auto-building the facets based on attributes,
-        if ($autoFacetAttributes) {
-            $facets = array_merge($this->buildAllAttributeFacets($matches), $facets);
-        }
-
-        // convert values to arraylist
-        $out = new ArrayList();
-        $sortValues = self::config()->sort_facet_values;
-        foreach ($facets as $f) {
-            if ($sortValues) {
-                ksort($f['Values']);
-            }
-            $f['Values'] = new ArrayList($f['Values']);
-            $out->push(new ArrayData($f));
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * NOTE: this will break if applied to something that's not a SiteTree subclass.
-     * @param DataList|PaginatedList $matches
-     * @param array $facet
-     * @param int $typeID
-     */
-    protected function buildAttributeFacet($matches, array &$facet, $typeID)
-    {
-        $q = $matches instanceof PaginatedList ? $matches->getList()->dataQuery()->query() : $matches->dataQuery()->query();
-
-        if (empty($facet['Label'])) {
-            $type = ProductAttributeType::get()->byID($typeID);
-            $facet['Label'] = $type->Label;
-        }
-
-        $baseTable = $q->getFrom();
-        if (is_array($baseTable)) {
-            $baseTable = reset($baseTable);
-        }
-
-        $q = $q->setSelect(array())
-            ->selectField('"ProductAttributeValue"."ID"', 'Value')
-            ->selectField('"ProductAttributeValue"."Value"', 'Label')
-            ->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
-            ->selectField('"ProductAttributeValue"."Sort"')
-            ->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
-            ->addInnerJoin('ProductAttributeValue', '"Product_StaticAttributeValues"."ProductAttributeValueID" = "ProductAttributeValue"."ID"')
-            ->addWhere(sprintf("\"ProductAttributeValue\".\"TypeID\" = '%d'", $typeID))
-            ->setOrderBy('"ProductAttributeValue"."Sort"', 'ASC')
-            ->setGroupBy('"ProductAttributeValue"."ID"')
-            ->execute()
-        ;
-
-        $facet['Values'] = array();
-        foreach ($q as $row) {
-            $facet['Values'][ $row['Value'] ] = new ArrayData($row);
-        }
-    }
-
-
-    /**
-     * Builds facets from all attributes present in the data set.
-     * @param DataList|PaginatedList $matches
-     * @return array
-     */
-    protected function buildAllAttributeFacets($matches)
-    {
-        $q = $matches instanceof PaginatedList ? $matches->getList()->dataQuery()->query() : $matches->dataQuery()->query();
-
-        // this is the easiest way to get SiteTree vs SiteTree_Live
-        $baseTable = $q->getFrom();
-        if (is_array($baseTable)) {
-            $baseTable = reset($baseTable);
-        }
-
-        $q = $q->setSelect(array())
-            ->selectField('"ProductAttributeType"."ID"', 'TypeID')
-            ->selectField('"ProductAttributeType"."Label"', 'TypeLabel')
-            ->selectField('"ProductAttributeValue"."ID"', 'Value')
-            ->selectField('"ProductAttributeValue"."Value"', 'Label')
-            ->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
-            ->selectField('"ProductAttributeValue"."Sort"')
-            ->addInnerJoin('Product_StaticAttributeTypes', $baseTable.'."ID" = "Product_StaticAttributeTypes"."ProductID"')
-            ->addInnerJoin('ProductAttributeType', '"Product_StaticAttributeTypes"."ProductAttributeTypeID" = "ProductAttributeType"."ID"')
-            ->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
-            ->addInnerJoin('ProductAttributeValue', '"Product_StaticAttributeValues"."ProductAttributeValueID" = "ProductAttributeValue"."ID"'
-                . ' AND "ProductAttributeValue"."TypeID" = "ProductAttributeType"."ID"')
-            ->setOrderBy(array(
-                '"ProductAttributeType"."Label"' => 'ASC',
-                '"ProductAttributeValue"."Sort"' => 'ASC',
-            ))
-            ->setGroupBy(array('"ProductAttributeValue"."ID"', '"ProductAttributeType"."ID"'))
-            ->execute()
-        ;
-
-
-        $curType  = 0;
-        $facets   = array();
-        $curFacet = null;
-        foreach ($q as $row) {
-            if ($curType != $row['TypeID']) {
-                if ($curType > 0) {
-                    $facets['ATT'.$curType] = $curFacet;
-                }
-                $curType = $row['TypeID'];
-                $curFacet = array(
-                    'Label'  => $row['TypeLabel'],
-                    'Source' => 'ATT'.$curType,
-                    'Type'   => ShopSearch::FACET_TYPE_LINK,
-                    'Values' => array(),
-                );
-            }
-
-            unset($row['TypeID']);
-            unset($row['TypeLabel']);
-            $curFacet['Values'][ $row['Value'] ] = new ArrayData($row);
-        }
-
-        if ($curType > 0) {
-            $facets['ATT'.$curType] = $curFacet;
-        }
-        return $facets;
-    }
-
-
-    /**
-     * Inserts a "Link" field into the values for each facet which can be
-     * used to get a filtered search based on that facets
-     *
-     * @param ArrayList $facets
-     * @param array     $baseParams
-     * @param string    $baseLink
-     * @return ArrayList
-     */
-    public function insertFacetLinks(ArrayList $facets, array $baseParams, $baseLink)
-    {
-        $qs_f   = Config::inst()->get('ShopSearch', 'qs_filters');
-        $qs_t   = Config::inst()->get('ShopSearch', 'qs_title');
-
-        foreach ($facets as $facet) {
-            switch ($facet->Type) {
-                case ShopSearch::FACET_TYPE_RANGE:
-                    $params = array_merge($baseParams, array());
-                    if (!isset($params[$qs_f])) {
-                        $params[$qs_f] = array();
-                    }
-                    $params[$qs_f][$facet->Source] = 'RANGEFACETVALUE';
-                    $params[$qs_t] = $facet->Label . ': RANGEFACETLABEL';
-                    $facet->Link = $baseLink . '?' . http_build_query($params);
-                break;
-
-                case ShopSearch::FACET_TYPE_CHECKBOX;
-                    $facet->LinkDetails = json_encode(array(
-                        'filter'    => $qs_f,
-                        'source'    => $facet->Source,
-                        'leaves'    => $facet->FilterOnlyLeaves,
-                    ));
-
-                    // fall through on purpose
-
-                default:
-                    foreach ($facet->Values as $value) {
-                        // make a copy of the existing params
-                        $params = array_merge($baseParams, array());
-
-                        // add the filter for this value
-                        if (!isset($params[$qs_f])) {
-                            $params[$qs_f] = array();
-                        }
-                        if ($facet->Type == ShopSearch::FACET_TYPE_CHECKBOX) {
-                            unset($params[$qs_f][$facet->Source]); // this will be figured out via javascript
-                            $params[$qs_t] = ($value->Active ? 'Remove ' : '') . $facet->Label . ': ' . $value->Label;
-                        } else {
-                            $params[$qs_f][$facet->Source] = $value->Value;
-                            $params[$qs_t] = $facet->Label . ': ' . $value->Label;
-                        }
-
-                        // build a new link
-                        $value->Link = $baseLink . '?' . http_build_query($params);
-                    }
-            }
-        }
-
-        return $facets;
-    }
-
-
-    /**
-     * @param ArrayList $children
-     * @return array
-     */
-    protected function getRecursiveChildValues(ArrayList $children)
-    {
-        $out = array();
-
-        foreach ($children as $child) {
-            $out[$child->Value] = $child->Value;
-            if (!empty($child->Children)) {
-                $out += $this->getRecursiveChildValues($child->Children);
-            }
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * For checkbox and range facets, this updates the state (checked and min/max)
-     * based on current filter values.
-     *
-     * @param ArrayList $facets
-     * @param array     $filters
-     * @return ArrayList
-     */
-    public function updateFacetState(ArrayList $facets, array $filters)
-    {
-        foreach ($facets as $facet) {
-            if ($facet->Type == ShopSearch::FACET_TYPE_CHECKBOX) {
-                if (empty($filters[$facet->Source])) {
-                    // If the filter is not being used at all, we count
-                    // all values as active.
-                    foreach ($facet->Values as $value) {
-                        $value->Active = (bool)FacetHelper::config()->default_checkbox_state;
-                    }
-                } else {
-                    $filterVals = $filters[$facet->Source];
-                    if (!is_array($filterVals)) {
-                        $filterVals = array($filterVals);
-                    }
-                    $this->updateCheckboxFacetState(
-                        !empty($facet->NestedValues) ? $facet->NestedValues : $facet->Values,
-                        $filterVals,
-                        !empty($facet->FilterOnlyLeaves));
-                }
-            } elseif ($facet->Type == ShopSearch::FACET_TYPE_RANGE) {
-                if (!empty($filters[$facet->Source]) && preg_match('/^RANGE\~(.+)\~(.+)$/', $filters[$facet->Source], $m)) {
-                    $facet->MinValue = $m[1];
-                    $facet->MaxValue = $m[2];
-                }
-            }
-        }
-
-        return $facets;
-    }
-
-
-    /**
-     * For checkboxes, updates the state based on filters. Handles hierarchies and FilterOnlyLeaves
-     * @param ArrayList $values
-     * @param array     $filterVals
-     * @param bool      $filterOnlyLeaves [optional]
-     * @return bool - true if any of the children are true, false if all children are false
-     */
-    protected function updateCheckboxFacetState(ArrayList $values, array $filterVals, $filterOnlyLeaves=false)
-    {
-        $out = false;
-
-        foreach ($values as $value) {
-            if ($filterOnlyLeaves && !empty($value->Children)) {
-                if (in_array($value->Value, $filterVals)) {
-                    // This wouldn't be normal, but even if it's not a leaf, we want to handle
-                    // the case where a filter might be set for this node. It should still show up correctly.
-                    $value->Active = true;
-                    foreach ($value->Children as $c) {
-                        $c->Active = true;
-                    }
-                    // TODO: handle more than one level of recursion here
-                } else {
-                    $value->Active = $this->updateCheckboxFacetState($value->Children, $filterVals, $filterOnlyLeaves);
-                }
-            } else {
-                $value->Active = in_array($value->Value, $filterVals);
-            }
-
-            if ($value->Active) {
-                $out = true;
-            }
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * If there are any facets (link or checkbox) that have a HierarchyDivider field
-     * in the spec, transform them into a hierarchy so they can be displayed as such.
-     *
-     * @param ArrayList $facets
-     * @return ArrayList
-     */
-    public function transformHierarchies(ArrayList $facets)
-    {
-        foreach ($facets as $facet) {
-            if (!empty($facet->HierarchyDivider)) {
-                $out = new ArrayList();
-                $parentStack = array();
-
-                foreach ($facet->Values as $value) {
-                    if (empty($value->Label)) {
-                        continue;
-                    }
-                    $value->FullLabel = $value->Label;
-
-                    // Look for the most recent parent that matches the beginning of this one
-                    while (count($parentStack) > 0) {
-                        $curParent = $parentStack[ count($parentStack)-1 ];
-                        if (strpos($value->Label, $curParent->FullLabel) === 0) {
-                            if (!isset($curParent->Children)) {
-                                $curParent->Children = new ArrayList();
-                            }
-
-                            // Modify the name so we only show the last component
-                            $value->FullLabel = $value->Label;
-                            $p = strrpos($value->Label, $facet->HierarchyDivider);
-                            if ($p > -1) {
-                                $value->Label = trim(substr($value->Label, $p + 1));
-                            }
-
-                            $curParent->Children->push($value);
-                            break;
-                        } else {
-                            array_pop($parentStack);
-                        }
-                    }
-
-                    // If we went all the way back to the root without a match, this is
-                    // a new parent item
-                    if (count($parentStack) == 0) {
-                        $out->push($value);
-                    }
-
-                    // Each item could be a potential parent. If it's not it will get popped
-                    // immediately on the next iteration
-                    $parentStack[] = $value;
-                }
-
-                $facet->NestedValues = $out;
-            }
-        }
-
-        return $facets;
-    }
+					// TODO: This logic should be something like the above, but I don't know
+					// how to get the join table from a singleton (which returns an UnsavedRelationList
+					// instead of a ManyManyList). I've got a deadline to meet, though, so this
+					// will catch the majority of cases as long as the extension is applied to the
+					// Product class instead of a subclass.
+					$list = $list
+						->innerJoin('Product_StaticAttributeTypes', "\"SiteTree\".\"ID\" = \"Product_StaticAttributeTypes\".\"ProductID\"")
+						->innerJoin('ProductAttributeValue', "\"Product_StaticAttributeTypes\".\"ProductAttributeTypeID\" = \"ProductAttributeValue\".\"TypeID\"")
+						->innerJoin('Product_StaticAttributeValues', "\"SiteTree\".\"ID\" = \"Product_StaticAttributeValues\".\"ProductID\" AND \"ProductAttributeValue\".\"ID\" = \"Product_StaticAttributeValues\".\"ProductAttributeValueID\"")
+						->filter("Product_StaticAttributeValues.ProductAttributeValueID", $filterVal);
+				} else {
+					$list = $list->filter($this->processFilterField($sing, $filterField, $filterVal));
+				}
+			}
+		}
+
+		return $list;
+	}
+
+
+	/**
+	 * @param DataObject $rec           This would normally just be a singleton but we don't want to have to create it over and over
+	 * @param string     $filterField
+	 * @param mixed      $filterVal
+	 * @return array - returns the new filter added
+	 */
+	public function processFilterField($rec, $filterField, $filterVal)
+	{
+		// First check for VFI fields
+		if ($rec->hasExtension('VirtualFieldIndex') && ($spec = $rec->getVFISpec($filterField))) {
+			if ($spec['Type'] == VirtualFieldIndex::TYPE_LIST) {
+				// Lists have to be handled a little differently
+				$f = $rec->getVFIFieldName($filterField) . ':PartialMatch';
+				if (is_array($filterVal)) {
+					foreach ($filterVal as &$val) {
+						$val = '|' . $val . '|';
+					}
+					return array($f => $filterVal);
+				} else {
+					return array($f => '|' . $filterVal . '|');
+				}
+			} else {
+				// Simples are simple
+				$filterField = $rec->getVFIFieldName($filterField);
+			}
+		}
+
+		// Next check for regular db fields
+		if ($rec->dbObject($filterField)) {
+			// Is it a range value?
+			if (is_string($filterVal) && preg_match('/^RANGE\~(.+)\~(.+)$/', $filterVal, $m)) {
+				$filterField .= ':Between';
+				$filterVal = array_slice($m, 1, 2);
+			}
+
+			return array($filterField => $filterVal);
+		}
+
+		return array();
+	}
+
+
+	/**
+	 * Processes the facet spec and removes any shorthand (field => label).
+	 * @param array $facetSpec
+	 * @return array
+	 */
+	public function expandFacetSpec(array $facetSpec)
+	{
+		if (is_null($facetSpec)) {
+			return array();
+		}
+		$facets = array();
+
+		foreach ($facetSpec as $field => $label) {
+			if (is_array($label)) {
+				$facets[$field] = $label;
+			} else {
+				$facets[$field] = array('Label' => $label);
+			}
+
+			if (empty($facets[$field]['Source'])) {
+				$facets[$field]['Source'] = $field;
+			}
+			if (empty($facets[$field]['Type'])) {
+				$facets[$field]['Type']  = ShopSearch::FACET_TYPE_LINK;
+			}
+
+			if (empty($facets[$field]['Values'])) {
+				$facets[$field]['Values'] = array();
+			} else {
+				$vals = $facets[$field]['Values'];
+				if (is_string($vals)) {
+					$vals = eval('return ' . $vals . ';');
+				}
+				$facets[$field]['Values'] = array();
+				foreach ($vals as $val => $lbl) {
+					$facets[$field]['Values'][$val] = new ArrayData(array(
+						'Label'     => $lbl,
+						'Value'     => $val,
+						'Count'     => 0,
+					));
+				}
+			}
+		}
+
+		return $facets;
+	}
+
+
+	/**
+	 * This is super-slow. I'm assuming if you're using facets you
+	 * probably also ought to be using Solr or something else. Or
+	 * maybe you have unlimited time and can refactor this feature
+	 * and submit a pull request...
+	 *
+	 * TODO: If this is going to be used for categories we're going
+	 * to have to really clean it up and speed it up.
+	 * Suggestion:
+	 *  - option to turn off counts
+	 *  - switch order of nested array so we don't go through results unless needed
+	 *  - if not doing counts, min/max and link facets can be handled w/ queries
+	 *  - separate that bit out into a new function
+	 * NOTE: This is partially done with the "faster_faceting" config
+	 * option but more could be done, particularly by covering link facets as well.
+	 *
+	 * Output - list of ArrayData in the format:
+	 *   Label - name of the facet
+	 *   Source - field name of the facet
+	 *   Type - one of the ShopSearch::FACET_TYPE_XXXX constants
+	 *   Values - SS_List of possible values for this facet
+	 *
+	 * @param SS_List $matches
+	 * @param array $facetSpec
+	 * @param bool $autoFacetAttributes [optional]
+	 * @return ArrayList
+	 */
+	public function buildFacets(SS_List $matches, array $facetSpec, $autoFacetAttributes=false)
+	{
+		$facets = $this->expandFacetSpec($facetSpec);
+		if (!$autoFacetAttributes && (empty($facets) || !$matches)) {
+			return new ArrayList();
+		}
+		$fasterMethod = (bool)$this->config()->faster_faceting;
+
+		// fill them in
+		foreach ($facets as $field => &$facet) {
+			if (preg_match(self::config()->attribute_facet_regex, $field, $m)) {
+				$this->buildAttributeFacet($matches, $facet, $m[1]);
+				continue;
+			}
+
+			// NOTE: using this method range and checkbox facets don't get counts
+			if ($fasterMethod && $facet['Type'] != ShopSearch::FACET_TYPE_LINK) {
+				if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
+					if (isset($facet['RangeMin'])) {
+						$facet['MinValue'] = $facet['RangeMin'];
+					}
+					if (isset($facet['RangeMax'])) {
+						$facet['MaxValue'] = $facet['RangeMax'];
+					}
+				}
+
+				continue;
+			}
+
+			foreach ($matches as $rec) {
+				// If it's a range facet, set up the min/max
+				if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
+					if (isset($facet['RangeMin'])) {
+						$facet['MinValue'] = $facet['RangeMin'];
+					}
+					if (isset($facet['RangeMax'])) {
+						$facet['MaxValue'] = $facet['RangeMax'];
+					}
+				}
+
+				// If the field is accessible via normal methods, including
+				// a user-defined getter, prefer that
+				$fieldValue = $rec->relObject($field);
+				if (is_null($fieldValue) && $rec->hasMethod($meth = "get{$field}")) {
+					$fieldValue = $rec->$meth();
+				}
+
+				// If not, look for a VFI field
+				if (!$fieldValue && $rec->hasExtension('VirtualFieldIndex')) {
+					$fieldValue = $rec->getVFI($field);
+				}
+
+				// If we found something, process it
+				if (!empty($fieldValue)) {
+					// normalize so that it's iterable
+					if (!is_array($fieldValue) && !$fieldValue instanceof SS_List) {
+						$fieldValue = array($fieldValue);
+					}
+
+					foreach ($fieldValue as $obj) {
+						if (empty($obj)) {
+							continue;
+						}
+
+						// figure out the right label
+						if (is_object($obj) && $obj->hasMethod('Nice')) {
+							$lbl = $obj->Nice();
+						} elseif (is_object($obj) && !empty($obj->Title)) {
+							$lbl = $obj->Title;
+						} elseif (
+							is_numeric($obj) &&
+							!empty($facet['LabelFormat']) &&
+							$facet['LabelFormat'] === 'Currency' &&
+							$facet['Type'] !== ShopSearch::FACET_TYPE_RANGE // this one handles it via javascript
+						) {
+							$tmp = Currency::create($field);
+							$tmp->setValue($obj);
+							$lbl = $tmp->Nice();
+						} else {
+							$lbl = (string)$obj;
+						}
+
+						// figure out the value for sorting
+						if (is_object($obj) && $obj->hasMethod('getAmount')) {
+							$val = $obj->getAmount();
+						} elseif (is_object($obj) && !empty($obj->ID)) {
+							$val = $obj->ID;
+						} else {
+							$val = (string)$obj;
+						}
+
+						// if it's a range facet, calculate the min and max
+						if ($facet['Type'] == ShopSearch::FACET_TYPE_RANGE) {
+							if (!isset($facet['MinValue']) || $val < $facet['MinValue']) {
+								$facet['MinValue'] = $val;
+								$facet['MinLabel'] = $lbl;
+							}
+							if (!isset($facet['RangeMin']) || $val < $facet['RangeMin']) {
+								$facet['RangeMin'] = $val;
+							}
+							if (!isset($facet['MaxValue']) || $val > $facet['MaxValue']) {
+								$facet['MaxValue'] = $val;
+								$facet['MaxLabel'] = $lbl;
+							}
+							if (!isset($facet['RangeMax']) || $val > $facet['RangeMax']) {
+								$facet['RangeMax'] = $val;
+							}
+						}
+
+						// Tally the value in the facets
+						if (!isset($facet['Values'][$val])) {
+							$facet['Values'][$val] = new ArrayData(array(
+								'Label'     => $lbl,
+								'Value'     => $val,
+								'Count'     => 1,
+							));
+						} elseif ($facet['Values'][$val]) {
+							$facet['Values'][$val]->Count++;
+						}
+					}
+				}
+			}
+		}
+
+		// if we're auto-building the facets based on attributes,
+		if ($autoFacetAttributes) {
+			$facets = array_merge($this->buildAllAttributeFacets($matches), $facets);
+		}
+
+		// convert values to arraylist
+		$out = new ArrayList();
+		$sortValues = self::config()->sort_facet_values;
+		foreach ($facets as $f) {
+			if ($sortValues) {
+				ksort($f['Values']);
+			}
+			$f['Values'] = new ArrayList($f['Values']);
+			$out->push(new ArrayData($f));
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * NOTE: this will break if applied to something that's not a SiteTree subclass.
+	 * @param DataList|PaginatedList $matches
+	 * @param array $facet
+	 * @param int $typeID
+	 */
+	protected function buildAttributeFacet($matches, array &$facet, $typeID)
+	{
+		$q = $matches instanceof PaginatedList ? $matches->getList()->dataQuery()->query() : $matches->dataQuery()->query();
+
+		if (empty($facet['Label'])) {
+			$type = ProductAttributeType::get()->byID($typeID);
+			$facet['Label'] = $type->Label;
+		}
+
+		$baseTable = $q->getFrom();
+		if (is_array($baseTable)) {
+			$baseTable = reset($baseTable);
+		}
+
+		$q = $q->setSelect(array())
+			->selectField('"ProductAttributeValue"."ID"', 'Value')
+			->selectField('"ProductAttributeValue"."Value"', 'Label')
+			->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
+			->selectField('"ProductAttributeValue"."Sort"')
+			->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
+			->addInnerJoin('ProductAttributeValue', '"Product_StaticAttributeValues"."ProductAttributeValueID" = "ProductAttributeValue"."ID"')
+			->addWhere(sprintf("\"ProductAttributeValue\".\"TypeID\" = '%d'", $typeID))
+			->setOrderBy('"ProductAttributeValue"."Sort"', 'ASC')
+			->setGroupBy('"ProductAttributeValue"."ID"')
+			->execute()
+		;
+
+		$facet['Values'] = array();
+		foreach ($q as $row) {
+			$facet['Values'][ $row['Value'] ] = new ArrayData($row);
+		}
+	}
+
+
+	/**
+	 * Builds facets from all attributes present in the data set.
+	 * @param DataList|PaginatedList $matches
+	 * @return array
+	 */
+	protected function buildAllAttributeFacets($matches)
+	{
+		$q = $matches instanceof PaginatedList ? $matches->getList()->dataQuery()->query() : $matches->dataQuery()->query();
+
+		// this is the easiest way to get SiteTree vs SiteTree_Live
+		$baseTable = $q->getFrom();
+		if (is_array($baseTable)) {
+			$baseTable = reset($baseTable);
+		}
+
+		$q = $q->setSelect(array())
+			->selectField('"ProductAttributeType"."ID"', 'TypeID')
+			->selectField('"ProductAttributeType"."Label"', 'TypeLabel')
+			->selectField('"ProductAttributeValue"."ID"', 'Value')
+			->selectField('"ProductAttributeValue"."Value"', 'Label')
+			->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
+			->selectField('"ProductAttributeValue"."Sort"')
+			->addInnerJoin('Product_StaticAttributeTypes', $baseTable.'."ID" = "Product_StaticAttributeTypes"."ProductID"')
+			->addInnerJoin('ProductAttributeType', '"Product_StaticAttributeTypes"."ProductAttributeTypeID" = "ProductAttributeType"."ID"')
+			->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
+			->addInnerJoin('ProductAttributeValue', '"Product_StaticAttributeValues"."ProductAttributeValueID" = "ProductAttributeValue"."ID"'
+				. ' AND "ProductAttributeValue"."TypeID" = "ProductAttributeType"."ID"')
+			->setOrderBy(array(
+				'"ProductAttributeType"."Label"' => 'ASC',
+				'"ProductAttributeValue"."Sort"' => 'ASC',
+			))
+			->setGroupBy(array('"ProductAttributeValue"."ID"', '"ProductAttributeType"."ID"'))
+			->execute()
+		;
+
+
+		$curType  = 0;
+		$facets   = array();
+		$curFacet = null;
+		foreach ($q as $row) {
+			if ($curType != $row['TypeID']) {
+				if ($curType > 0) {
+					$facets['ATT'.$curType] = $curFacet;
+				}
+				$curType = $row['TypeID'];
+				$curFacet = array(
+					'Label'  => $row['TypeLabel'],
+					'Source' => 'ATT'.$curType,
+					'Type'   => ShopSearch::FACET_TYPE_LINK,
+					'Values' => array(),
+				);
+			}
+
+			unset($row['TypeID']);
+			unset($row['TypeLabel']);
+			$curFacet['Values'][ $row['Value'] ] = new ArrayData($row);
+		}
+
+		if ($curType > 0) {
+			$facets['ATT'.$curType] = $curFacet;
+		}
+		return $facets;
+	}
+
+
+	/**
+	 * Inserts a "Link" field into the values for each facet which can be
+	 * used to get a filtered search based on that facets
+	 *
+	 * @param ArrayList $facets
+	 * @param array     $baseParams
+	 * @param string    $baseLink
+	 * @return ArrayList
+	 */
+	public function insertFacetLinks(ArrayList $facets, array $baseParams, $baseLink)
+	{
+		$qs_f   = Config::inst()->get('ShopSearch', 'qs_filters');
+		$qs_t   = Config::inst()->get('ShopSearch', 'qs_title');
+
+		foreach ($facets as $facet) {
+			switch ($facet->Type) {
+				case ShopSearch::FACET_TYPE_RANGE:
+					$params = array_merge($baseParams, array());
+					if (!isset($params[$qs_f])) {
+						$params[$qs_f] = array();
+					}
+					$params[$qs_f][$facet->Source] = 'RANGEFACETVALUE';
+					$params[$qs_t] = $facet->Label . ': RANGEFACETLABEL';
+					$facet->Link = $baseLink . '?' . http_build_query($params);
+				break;
+
+				case ShopSearch::FACET_TYPE_CHECKBOX;
+					$facet->LinkDetails = json_encode(array(
+						'filter'    => $qs_f,
+						'source'    => $facet->Source,
+						'leaves'    => $facet->FilterOnlyLeaves,
+					));
+
+					// fall through on purpose
+
+				default:
+					foreach ($facet->Values as $value) {
+						// make a copy of the existing params
+						$params = array_merge($baseParams, array());
+
+						// add the filter for this value
+						if (!isset($params[$qs_f])) {
+							$params[$qs_f] = array();
+						}
+						if ($facet->Type == ShopSearch::FACET_TYPE_CHECKBOX) {
+							unset($params[$qs_f][$facet->Source]); // this will be figured out via javascript
+							$params[$qs_t] = ($value->Active ? 'Remove ' : '') . $facet->Label . ': ' . $value->Label;
+						} else {
+							$params[$qs_f][$facet->Source] = $value->Value;
+							$params[$qs_t] = $facet->Label . ': ' . $value->Label;
+						}
+
+						// build a new link
+						$value->Link = $baseLink . '?' . http_build_query($params);
+					}
+			}
+		}
+
+		return $facets;
+	}
+
+
+	/**
+	 * @param ArrayList $children
+	 * @return array
+	 */
+	protected function getRecursiveChildValues(ArrayList $children)
+	{
+		$out = array();
+
+		foreach ($children as $child) {
+			$out[$child->Value] = $child->Value;
+			if (!empty($child->Children)) {
+				$out += $this->getRecursiveChildValues($child->Children);
+			}
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * For checkbox and range facets, this updates the state (checked and min/max)
+	 * based on current filter values.
+	 *
+	 * @param ArrayList $facets
+	 * @param array     $filters
+	 * @return ArrayList
+	 */
+	public function updateFacetState(ArrayList $facets, array $filters)
+	{
+		foreach ($facets as $facet) {
+			if ($facet->Type == ShopSearch::FACET_TYPE_CHECKBOX) {
+				if (empty($filters[$facet->Source])) {
+					// If the filter is not being used at all, we count
+					// all values as active.
+					foreach ($facet->Values as $value) {
+						$value->Active = (bool)FacetHelper::config()->default_checkbox_state;
+					}
+				} else {
+					$filterVals = $filters[$facet->Source];
+					if (!is_array($filterVals)) {
+						$filterVals = array($filterVals);
+					}
+					$this->updateCheckboxFacetState(
+						!empty($facet->NestedValues) ? $facet->NestedValues : $facet->Values,
+						$filterVals,
+						!empty($facet->FilterOnlyLeaves));
+				}
+			} elseif ($facet->Type == ShopSearch::FACET_TYPE_RANGE) {
+				if (!empty($filters[$facet->Source]) && preg_match('/^RANGE\~(.+)\~(.+)$/', $filters[$facet->Source], $m)) {
+					$facet->MinValue = $m[1];
+					$facet->MaxValue = $m[2];
+				}
+			}
+		}
+
+		return $facets;
+	}
+
+
+	/**
+	 * For checkboxes, updates the state based on filters. Handles hierarchies and FilterOnlyLeaves
+	 * @param ArrayList $values
+	 * @param array     $filterVals
+	 * @param bool      $filterOnlyLeaves [optional]
+	 * @return bool - true if any of the children are true, false if all children are false
+	 */
+	protected function updateCheckboxFacetState(ArrayList $values, array $filterVals, $filterOnlyLeaves=false)
+	{
+		$out = false;
+
+		foreach ($values as $value) {
+			if ($filterOnlyLeaves && !empty($value->Children)) {
+				if (in_array($value->Value, $filterVals)) {
+					// This wouldn't be normal, but even if it's not a leaf, we want to handle
+					// the case where a filter might be set for this node. It should still show up correctly.
+					$value->Active = true;
+					foreach ($value->Children as $c) {
+						$c->Active = true;
+					}
+					// TODO: handle more than one level of recursion here
+				} else {
+					$value->Active = $this->updateCheckboxFacetState($value->Children, $filterVals, $filterOnlyLeaves);
+				}
+			} else {
+				$value->Active = in_array($value->Value, $filterVals);
+			}
+
+			if ($value->Active) {
+				$out = true;
+			}
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * If there are any facets (link or checkbox) that have a HierarchyDivider field
+	 * in the spec, transform them into a hierarchy so they can be displayed as such.
+	 *
+	 * @param ArrayList $facets
+	 * @return ArrayList
+	 */
+	public function transformHierarchies(ArrayList $facets)
+	{
+		foreach ($facets as $facet) {
+			if (!empty($facet->HierarchyDivider)) {
+				$out = new ArrayList();
+				$parentStack = array();
+
+				foreach ($facet->Values as $value) {
+					if (empty($value->Label)) {
+						continue;
+					}
+					$value->FullLabel = $value->Label;
+
+					// Look for the most recent parent that matches the beginning of this one
+					while (count($parentStack) > 0) {
+						$curParent = $parentStack[ count($parentStack)-1 ];
+						if (strpos($value->Label, $curParent->FullLabel) === 0) {
+							if (!isset($curParent->Children)) {
+								$curParent->Children = new ArrayList();
+							}
+
+							// Modify the name so we only show the last component
+							$value->FullLabel = $value->Label;
+							$p = strrpos($value->Label, $facet->HierarchyDivider);
+							if ($p > -1) {
+								$value->Label = trim(substr($value->Label, $p + 1));
+							}
+
+							$curParent->Children->push($value);
+							break;
+						} else {
+							array_pop($parentStack);
+						}
+					}
+
+					// If we went all the way back to the root without a match, this is
+					// a new parent item
+					if (count($parentStack) == 0) {
+						$out->push($value);
+					}
+
+					// Each item could be a potential parent. If it's not it will get popped
+					// immediately on the next iteration
+					$parentStack[] = $value;
+				}
+
+				$facet->NestedValues = $out;
+			}
+		}
+
+		return $facets;
+	}
 }

code/helpers/HasStaticAttributes.php

Doc Comments +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
 
     /**
      * @param $typeID
-     * @return callable
+     * @return Closure
      */
     protected function getValuesClosure($typeID)
     {

Indentation +177 added lines, -177 removed lines

@@ -11,93 +11,93 @@ 
  */
 class HasStaticAttributes extends DataExtension
 {
-    private static $many_many = array(
-        'StaticAttributeTypes'  => 'ProductAttributeType',
-        'StaticAttributeValues' => 'ProductAttributeValue',
-    );
-
-
-    /**
-     * Adds variations specific fields to the CMS.
-     */
-    public function updateCMSFields(FieldList $fields)
-    {
-        $fields->addFieldsToTab('Root.Attributes', array(
-            HeaderField::create('Applicable Attribute Types'),
-            CheckboxSetField::create('StaticAttributeTypes', 'Static Attribute Types', ProductAttributeType::get()->map("ID", "Title")),
-            LiteralField::create('staticattributehelp', '<p>Select any attributes that apply to this product and click Save.</p>'),
-            HeaderField::create('Attributes'),
-        ));
-
-        foreach ($this->owner->StaticAttributeTypes() as $type) {
-            $source = $this->getValuesClosure($type->ID);
-
-            $newValFields = FieldList::create(array(
-                TextField::create('Value', 'Label'),
-                HiddenField::create('TypeID', '', $type->ID),
-            ));
-
-            $newValReq = RequiredFields::create('Value');
-
-            $valuesField = HasStaticAttributes_CheckboxSetField::create('StaticAttributeValues-'.$type->ID, $type->Title, $source());
-            $valuesField->setValue($this->owner->StaticAttributeValues()->filter('TypeID', $type->ID)->getIDList());
-            $valuesField->useAddNew('ProductAttributeValue', $source, $newValFields, $newValReq);
-
-            $fields->addFieldToTab('Root.Attributes', $valuesField);
-        }
-    }
-
-
-    /**
-     * @param $typeID
-     * @return callable
-     */
-    protected function getValuesClosure($typeID)
-    {
-        return function () use ($typeID) {
-            return ProductAttributeValue::get()->filter('TypeID', $typeID)->map('ID', 'Value')->toArray();
-        };
-    }
-
-
-    /**
-     * @return ArrayList
-     */
-    public function StaticAttributes()
-    {
-        $list = array();
-
-        foreach ($this->owner->StaticAttributeTypes() as $type) {
-            $type->ActiveValues = new ArrayList();
-            $list[$type->ID] = $type;
-        }
-
-        foreach ($this->owner->StaticAttributeValues() as $val) {
-            if (!isset($list[$val->TypeID])) {
-                continue;
-            }
-            $list[$val->TypeID]->ActiveValues->push($val);
-        }
-
-        return new ArrayList($list);
-    }
-
-
-    /**
-     * Add the default attribute types if any
-     */
-    public function onBeforeWrite()
-    {
-        if (empty($this->owner->ID)) {
-            $defaultAttributes = Config::inst()->get($this->owner->ClassName, 'default_attributes');
-            if (!empty($defaultAttributes)) {
-                $types = $this->owner->StaticAttributeTypes();
-                foreach ($defaultAttributes as $typeID) {
-                    $types->add($typeID);
-                }
-            }
-        }
-    }
+	private static $many_many = array(
+		'StaticAttributeTypes'  => 'ProductAttributeType',
+		'StaticAttributeValues' => 'ProductAttributeValue',
+	);
+
+
+	/**
+	 * Adds variations specific fields to the CMS.
+	 */
+	public function updateCMSFields(FieldList $fields)
+	{
+		$fields->addFieldsToTab('Root.Attributes', array(
+			HeaderField::create('Applicable Attribute Types'),
+			CheckboxSetField::create('StaticAttributeTypes', 'Static Attribute Types', ProductAttributeType::get()->map("ID", "Title")),
+			LiteralField::create('staticattributehelp', '<p>Select any attributes that apply to this product and click Save.</p>'),
+			HeaderField::create('Attributes'),
+		));
+
+		foreach ($this->owner->StaticAttributeTypes() as $type) {
+			$source = $this->getValuesClosure($type->ID);
+
+			$newValFields = FieldList::create(array(
+				TextField::create('Value', 'Label'),
+				HiddenField::create('TypeID', '', $type->ID),
+			));
+
+			$newValReq = RequiredFields::create('Value');
+
+			$valuesField = HasStaticAttributes_CheckboxSetField::create('StaticAttributeValues-'.$type->ID, $type->Title, $source());
+			$valuesField->setValue($this->owner->StaticAttributeValues()->filter('TypeID', $type->ID)->getIDList());
+			$valuesField->useAddNew('ProductAttributeValue', $source, $newValFields, $newValReq);
+
+			$fields->addFieldToTab('Root.Attributes', $valuesField);
+		}
+	}
+
+
+	/**
+	 * @param $typeID
+	 * @return callable
+	 */
+	protected function getValuesClosure($typeID)
+	{
+		return function () use ($typeID) {
+			return ProductAttributeValue::get()->filter('TypeID', $typeID)->map('ID', 'Value')->toArray();
+		};
+	}
+
+
+	/**
+	 * @return ArrayList
+	 */
+	public function StaticAttributes()
+	{
+		$list = array();
+
+		foreach ($this->owner->StaticAttributeTypes() as $type) {
+			$type->ActiveValues = new ArrayList();
+			$list[$type->ID] = $type;
+		}
+
+		foreach ($this->owner->StaticAttributeValues() as $val) {
+			if (!isset($list[$val->TypeID])) {
+				continue;
+			}
+			$list[$val->TypeID]->ActiveValues->push($val);
+		}
+
+		return new ArrayList($list);
+	}
+
+
+	/**
+	 * Add the default attribute types if any
+	 */
+	public function onBeforeWrite()
+	{
+		if (empty($this->owner->ID)) {
+			$defaultAttributes = Config::inst()->get($this->owner->ClassName, 'default_attributes');
+			if (!empty($defaultAttributes)) {
+				$types = $this->owner->StaticAttributeTypes();
+				foreach ($defaultAttributes as $typeID) {
+					$types->add($typeID);
+				}
+			}
+		}
+	}
 }
 
 
@@ -110,96 +110,96 @@ 
  */
 class HasStaticAttributes_CheckboxSetField extends CheckboxSetField
 {
-    /**
-     * @return int
-     */
-    public function getAttributeTypeID()
-    {
-        $parts = explode('-', $this->name);
-        return count($parts) > 1 ? $parts[1] : 0;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getFieldName()
-    {
-        $parts = explode('-', $this->name);
-        return count($parts) > 0 ? $parts[0] : '';
-    }
-
-
-    /**
-     * Save the current value of this CheckboxSetField into a DataObject.
-     * If the field it is saving to is a has_many or many_many relationship,
-     * it is saved by setByIDList(), otherwise it creates a comma separated
-     * list for a standard DB text/varchar field.
-     *
-     * @param DataObjectInterface $record The record to save into
-     */
-    public function saveInto(DataObjectInterface $record)
-    {
-        $fieldname  = $this->getFieldName();
-        if (empty($fieldname)) {
-            return;
-        }
-        $typeID     = $this->getAttributeTypeID();
-        if (empty($typeID)) {
-            return;
-        }
-        $relation   = $record->$fieldname();
-        if (!$relation) {
-            return;
-        }
-        $relation   = $relation->filter('TypeID', $typeID);
-
-        // make a list of id's that should be there
-        $idList = array();
-        if (!empty($this->value) && is_array($this->value)) {
-            foreach ($this->value as $id => $bool) {
-                if ($bool) {
-                    $idList[$id] = $id;
-                }
-            }
-        }
-
-        // look at the existing elements and add/subtract
-        $toDelete = array();
-        foreach ($relation as $rec) {
-            if (isset($idList[$rec->ID])) {
-                // don't try to add it twice
-                unset($idList[$rec->ID]);
-            } else {
-                $toDelete[] = $rec->ID;
-            }
-        }
-
-        // add
-        foreach ($idList as $id) {
-            $relation->add($id);
-        }
-
-        // remove
-        foreach ($toDelete as $id) {
-            $relation->removeByID($id);
-        }
-    }
-
-
-    /**
-     * Load a value into this CheckboxSetField
-     */
-    public function setValue($value, $obj = null)
-    {
-        if (!empty($value) && !is_array($value) && !empty($this->value)) {
-            $this->value[] = $value;
-        } else {
-            parent::setValue($value, $obj);
-        }
-
-        return $this;
-    }
+	/**
+	 * @return int
+	 */
+	public function getAttributeTypeID()
+	{
+		$parts = explode('-', $this->name);
+		return count($parts) > 1 ? $parts[1] : 0;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getFieldName()
+	{
+		$parts = explode('-', $this->name);
+		return count($parts) > 0 ? $parts[0] : '';
+	}
+
+
+	/**
+	 * Save the current value of this CheckboxSetField into a DataObject.
+	 * If the field it is saving to is a has_many or many_many relationship,
+	 * it is saved by setByIDList(), otherwise it creates a comma separated
+	 * list for a standard DB text/varchar field.
+	 *
+	 * @param DataObjectInterface $record The record to save into
+	 */
+	public function saveInto(DataObjectInterface $record)
+	{
+		$fieldname  = $this->getFieldName();
+		if (empty($fieldname)) {
+			return;
+		}
+		$typeID     = $this->getAttributeTypeID();
+		if (empty($typeID)) {
+			return;
+		}
+		$relation   = $record->$fieldname();
+		if (!$relation) {
+			return;
+		}
+		$relation   = $relation->filter('TypeID', $typeID);
+
+		// make a list of id's that should be there
+		$idList = array();
+		if (!empty($this->value) && is_array($this->value)) {
+			foreach ($this->value as $id => $bool) {
+				if ($bool) {
+					$idList[$id] = $id;
+				}
+			}
+		}
+
+		// look at the existing elements and add/subtract
+		$toDelete = array();
+		foreach ($relation as $rec) {
+			if (isset($idList[$rec->ID])) {
+				// don't try to add it twice
+				unset($idList[$rec->ID]);
+			} else {
+				$toDelete[] = $rec->ID;
+			}
+		}
+
+		// add
+		foreach ($idList as $id) {
+			$relation->add($id);
+		}
+
+		// remove
+		foreach ($toDelete as $id) {
+			$relation->removeByID($id);
+		}
+	}
+
+
+	/**
+	 * Load a value into this CheckboxSetField
+	 */
+	public function setValue($value, $obj = null)
+	{
+		if (!empty($value) && !is_array($value) && !empty($this->value)) {
+			$this->value[] = $value;
+		} else {
+			parent::setValue($value, $obj);
+		}
+
+		return $this;
+	}
 }
 
 

Spacing +5 added lines, -5 removed lines

@@ -54,7 +54,7 @@ 
      */
     protected function getValuesClosure($typeID)
     {
-        return function () use ($typeID) {
+        return function() use ($typeID) {
             return ProductAttributeValue::get()->filter('TypeID', $typeID)->map('ID', 'Value')->toArray();
         };
     }
@@ -140,19 +140,19 @@ 
      */
     public function saveInto(DataObjectInterface $record)
     {
-        $fieldname  = $this->getFieldName();
+        $fieldname = $this->getFieldName();
         if (empty($fieldname)) {
             return;
         }
-        $typeID     = $this->getAttributeTypeID();
+        $typeID = $this->getAttributeTypeID();
         if (empty($typeID)) {
             return;
         }
-        $relation   = $record->$fieldname();
+        $relation = $record->$fieldname();
         if (!$relation) {
             return;
         }
-        $relation   = $relation->filter('TypeID', $typeID);
+        $relation = $relation->filter('TypeID', $typeID);
 
         // make a list of id's that should be there
         $idList = array();

code/helpers/VirtualFieldIndex.php

Doc Comments +1 added lines, -1 removed lines

@@ -243,7 +243,7 @@
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @return string
      */
     public function getVFIFieldName($name)

Indentation +408 added lines, -408 removed lines

@@ -41,413 +41,413 @@
  */
 class VirtualFieldIndex extends DataExtension
 {
-    const TYPE_LIST     = 'list';
-    const TYPE_SIMPLE   = 'simple';
-    const DEPENDS_ALL   = 'all';
-    const DEPENDS_NONE  = 'none';
-
-    /** @var array - central config for all models */
-    private static $vfi_spec = array();
-
-    /** @var bool - if you set this to true it will write to both live and stage using DB::query and save some time, possibly */
-    private static $fast_writes_enabled = false;
-
-    /** @var bool - used to prevent an infinite loop in onBeforeWrite */
-    protected $isRebuilding = false;
-
-    public static $disable_building = false;
-
-    /**
-     * @return array
-     */
-    public static function get_classes_with_vfi()
-    {
-        $vfi_def = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
-        if (!$vfi_def || !is_array($vfi_def)) {
-            return array();
-        }
-        return array_keys($vfi_def);
-    }
-
-    /**
-     * Define extra db fields and indexes.
-     * @param $class
-     * @param $extension
-     * @param $args
-     * @return array
-     */
-    public static function get_extra_config($class, $extension, $args)
-    {
-        $vfi_def = self::get_vfi_spec($class);
-        if (!$vfi_def || !is_array($vfi_def)) {
-            return array();
-        }
-
-        $out = array(
-            'db'        => array(),
-            'indexes'   => array(),
-        );
-
-        foreach ($vfi_def as $field => $spec) {
-            $fn = 'VFI_' . $field;
-            $out['db'][$fn] = isset($spec['DBField']) ? $spec['DBField'] : 'Varchar(255)';
-            $out['indexes'][$fn] = true;
-        }
-
-        return $out;
-    }
-
-
-    /**
-     * Return a normalized version of the vfi definition for a given class
-     * @param string $class
-     * @return array
-     */
-    public static function get_vfi_spec($class)
-    {
-        $vfi_master = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
-        if (!$vfi_master || !is_array($vfi_master)) {
-            return array();
-        }
-
-        // merge in all the vfi's from ancestors as well
-        $vfi_def = array();
-        foreach (ClassInfo::ancestry($class) as $c) {
-            if (!empty($vfi_master[$c])) {
-                // we want newer classes to override parent classes so we do it this way
-                $vfi_def = $vfi_master[$c] + $vfi_def;
-            }
-        }
-        if (empty($vfi_def)) {
-            return array();
-        }
-
-        // convert shorthand to longhand
-        foreach ($vfi_def as $k => $v) {
-            if (is_numeric($k)) {
-                $vfi_def[$v] = $v;
-                unset($vfi_def[$k]);
-            } elseif (is_string($v)) {
-                $vfi_def[$k] = array(
-                    'Type'      => self::TYPE_SIMPLE,
-                    'DependsOn' => self::DEPENDS_ALL,
-                    'Source'    => $v,
-                );
-            } elseif (is_array($v) && !isset($vfi_def[$k]['Source'])) {
-                $vfi_def[$k] = array(
-                    'Type'      => self::TYPE_LIST,
-                    'DependsOn' => self::DEPENDS_ALL,
-                    'Source'    => $v,
-                );
-            } else {
-                if (!isset($v['Type'])) {
-                    $vfi_def[$k]['Type'] = is_array($v['Source']) ? self::TYPE_LIST : self::TYPE_SIMPLE;
-                }
-                if (!isset($v['DependsOn'])) {
-                    $vfi_def[$k]['DependsOn'] = self::DEPENDS_ALL;
-                }
-            }
-        }
-
-        return $vfi_def;
-    }
-
-    /**
-     * Rebuilds any vfi fields on one class (or all). Doing it in chunks means a few more
-     * queries but it means we can handle larger datasets without storing everything in memory.
-     *
-     * @param string $class [optional] - if not given all indexes will be rebuilt
-     */
-    public static function build($class='')
-    {
-        if ($class) {
-            $list   = DataObject::get($class);
-            $count  = $list->count();
-            for ($i = 0; $i < $count; $i += 10) {
-                $chunk = $list->limit(10, $i);
+	const TYPE_LIST     = 'list';
+	const TYPE_SIMPLE   = 'simple';
+	const DEPENDS_ALL   = 'all';
+	const DEPENDS_NONE  = 'none';
+
+	/** @var array - central config for all models */
+	private static $vfi_spec = array();
+
+	/** @var bool - if you set this to true it will write to both live and stage using DB::query and save some time, possibly */
+	private static $fast_writes_enabled = false;
+
+	/** @var bool - used to prevent an infinite loop in onBeforeWrite */
+	protected $isRebuilding = false;
+
+	public static $disable_building = false;
+
+	/**
+	 * @return array
+	 */
+	public static function get_classes_with_vfi()
+	{
+		$vfi_def = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
+		if (!$vfi_def || !is_array($vfi_def)) {
+			return array();
+		}
+		return array_keys($vfi_def);
+	}
+
+	/**
+	 * Define extra db fields and indexes.
+	 * @param $class
+	 * @param $extension
+	 * @param $args
+	 * @return array
+	 */
+	public static function get_extra_config($class, $extension, $args)
+	{
+		$vfi_def = self::get_vfi_spec($class);
+		if (!$vfi_def || !is_array($vfi_def)) {
+			return array();
+		}
+
+		$out = array(
+			'db'        => array(),
+			'indexes'   => array(),
+		);
+
+		foreach ($vfi_def as $field => $spec) {
+			$fn = 'VFI_' . $field;
+			$out['db'][$fn] = isset($spec['DBField']) ? $spec['DBField'] : 'Varchar(255)';
+			$out['indexes'][$fn] = true;
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * Return a normalized version of the vfi definition for a given class
+	 * @param string $class
+	 * @return array
+	 */
+	public static function get_vfi_spec($class)
+	{
+		$vfi_master = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
+		if (!$vfi_master || !is_array($vfi_master)) {
+			return array();
+		}
+
+		// merge in all the vfi's from ancestors as well
+		$vfi_def = array();
+		foreach (ClassInfo::ancestry($class) as $c) {
+			if (!empty($vfi_master[$c])) {
+				// we want newer classes to override parent classes so we do it this way
+				$vfi_def = $vfi_master[$c] + $vfi_def;
+			}
+		}
+		if (empty($vfi_def)) {
+			return array();
+		}
+
+		// convert shorthand to longhand
+		foreach ($vfi_def as $k => $v) {
+			if (is_numeric($k)) {
+				$vfi_def[$v] = $v;
+				unset($vfi_def[$k]);
+			} elseif (is_string($v)) {
+				$vfi_def[$k] = array(
+					'Type'      => self::TYPE_SIMPLE,
+					'DependsOn' => self::DEPENDS_ALL,
+					'Source'    => $v,
+				);
+			} elseif (is_array($v) && !isset($vfi_def[$k]['Source'])) {
+				$vfi_def[$k] = array(
+					'Type'      => self::TYPE_LIST,
+					'DependsOn' => self::DEPENDS_ALL,
+					'Source'    => $v,
+				);
+			} else {
+				if (!isset($v['Type'])) {
+					$vfi_def[$k]['Type'] = is_array($v['Source']) ? self::TYPE_LIST : self::TYPE_SIMPLE;
+				}
+				if (!isset($v['DependsOn'])) {
+					$vfi_def[$k]['DependsOn'] = self::DEPENDS_ALL;
+				}
+			}
+		}
+
+		return $vfi_def;
+	}
+
+	/**
+	 * Rebuilds any vfi fields on one class (or all). Doing it in chunks means a few more
+	 * queries but it means we can handle larger datasets without storing everything in memory.
+	 *
+	 * @param string $class [optional] - if not given all indexes will be rebuilt
+	 */
+	public static function build($class='')
+	{
+		if ($class) {
+			$list   = DataObject::get($class);
+			$count  = $list->count();
+			for ($i = 0; $i < $count; $i += 10) {
+				$chunk = $list->limit(10, $i);
 //				if (Controller::curr() instanceof TaskRunner) echo "Processing VFI #$i...\n";
-                foreach ($chunk as $rec) {
-                    $rec->rebuildVFI();
-                }
-            }
-        } else {
-            foreach (self::get_classes_with_vfi() as $c) {
-                self::build($c);
-            }
-        }
-    }
-
-    /**
-     * Rebuild all vfi fields.
-     */
-    public function rebuildVFI($field = '')
-    {
-        if ($field) {
-            $this->isRebuilding = true;
-            $spec   = $this->getVFISpec($field);
-            $fn     = $this->getVFIFieldName($field);
-            $val    = $this->getVFI($field, true);
-
-            if ($spec['Type'] == self::TYPE_LIST) {
-                if (is_object($val)) {
-                    $val = $val->toArray();
-                }    // this would be an ArrayList or DataList
-                if (!is_array($val)) {
-                    $val = array($val);
-                }        // this would be a scalar value
-                $val = self::encode_list($val);
-            } else {
-                if (is_array($val)) {
-                    $val = (string)$val[0];
-                }    // if they give us an array, just take the first value
-                if (is_object($val)) {
-                    $val = (string)$val->first();
-                }  // if a SS_List, take the first as well
-            }
-
-            if (Config::inst()->get('VirtualFieldIndex', 'fast_writes_enabled')) {
-                // NOTE: this is usually going to be bad practice, but if you
-                // have a lot of products and a lot of on...Write handlers that
-                // can get tedious really quick. This is just here as an option.
-                $table = '';
-                foreach ($this->owner->getClassAncestry() as $ancestor) {
-                    if (DataObject::has_own_table($ancestor)) {
-                        $sing = singleton($ancestor);
-                        if ($sing->hasOwnTableDatabaseField($fn)) {
-                            $table = $ancestor;
-                            break;
-                        }
-                    }
-                }
-
-                if (!empty($table)) {
-                    DB::query($sql = sprintf("UPDATE %s SET %s = '%s' WHERE ID = '%d'", $table, $fn, Convert::raw2sql($val), $this->owner->ID));
-                    DB::query(sprintf("UPDATE %s_Live SET %s = '%s' WHERE ID = '%d'", $table, $fn, Convert::raw2sql($val), $this->owner->ID));
-                    $this->owner->setField($fn, $val);
-                } else {
-                    // if we couldn't figure out the right table, fall back to the old fashioned way
-                    $this->owner->setField($fn, $val);
-                    $this->owner->write();
-                }
-            } else {
-                $this->owner->setField($fn, $val);
-                $this->owner->write();
-            }
-            $this->isRebuilding = false;
-        } else {
-            // rebuild all fields if they didn't specify
-            foreach ($this->getVFISpec() as $field => $spec) {
-                $this->rebuildVFI($field);
-            }
-        }
-    }
-
-    /**
-     * @param $name
-     * @return string
-     */
-    public function getVFIFieldName($name)
-    {
-        return 'VFI_' . $name;
-    }
-
-
-    /**
-     * @param string $field [optional]
-     * @return array|false
-     */
-    public function getVFISpec($field = '')
-    {
-        $spec = self::get_vfi_spec($this->owner->class);
-        if ($field) {
-            return empty($spec[$field]) ? false : $spec[$field];
-        } else {
-            return $spec;
-        }
-    }
-
-
-    /**
-     * @param string $field
-     * @param bool   $fromSource [optional] - if true, it will regenerate the data from the source fields
-     * @param bool   $forceIDs [optional] - if true, it will return an ID even if the norm is to return a DataObject
-     * @return string|array|SS_List
-     */
-    public function getVFI($field, $fromSource=false, $forceIDs=false)
-    {
-        $spec = $this->getVFISpec($field);
-        if (!$spec) {
-            return null;
-        }
-        if ($fromSource) {
-            if (is_array($spec['Source'])) {
-                $out = array();
-                foreach ($spec['Source'] as $src) {
-                    $myOut = self::get_value($src, $this->owner);
-                    if (is_array($myOut)) {
-                        $out = array_merge($out, $myOut);
-                    } elseif (is_object($myOut) && $myOut instanceof SS_List) {
-                        $out = array_merge($out, $myOut->toArray());
-                    } else {
-                        $out[] = $myOut;
-                    }
-                }
-                return $out;
-            } else {
-                return self::get_value($spec['Source'], $this->owner);
-            }
-        } else {
-            $val = $this->owner->getField($this->getVFIFieldName($field));
-            if ($spec['Type'] == self::TYPE_LIST) {
-                return self::decode_list($val, $forceIDs);
-            } else {
-                return $val;
-            }
-        }
-    }
-
-
-    /**
-     * Template version
-     * @param string $field
-     * @return string|array|SS_List
-     */
-    public function VFI($field)
-    {
-        return $this->getVFI($field);
-    }
-
-
-    /**
-     * @param array $list
-     * @return string
-     */
-    protected static function encode_list(array $list)
-    {
-        // If we've got objects, encode them a little differently
-        if (count($list) > 0 && is_object($list[0])) {
-            $ids = array();
-            foreach ($list as $rec) {
-                $ids[] = $rec->ID;
-            }
-            $val = '>' . $list[0]->ClassName . '|' . implode('|', $ids) . '|';
-        } else {
-            $val = '|' . implode('|', $list) . '|';
-        }
-
-        return $val;
-    }
-
-
-    /**
-     * @param string $val
-     * @param bool   $forceIDs [optional] - if true encoded objects will not be returned as objects but as id's
-     * @return array
-     */
-    protected static function decode_list($val, $forceIDs=false)
-    {
-        if ($val[0] == '>') {
-            $firstBar = strpos($val, '|');
-            if ($firstBar < 3) {
-                return array();
-            }
-            $className = substr($val, 1, $firstBar-1);
-            $ids = explode('|', trim(substr($val, $firstBar), '|'));
-            return $forceIDs ? $ids : DataObject::get($className)->filter('ID', $ids)->toArray();
-        } else {
-            return explode('|', trim($val, '|'));
-        }
-    }
-
-
-    /**
-     * This is largely borrowed from DataObject::relField, but
-     * adapted to work with many-many and has-many fields.
-     * @param string $fieldName
-     * @param DataObject $rec
-     * @return mixed
-     */
-    protected static function get_value($fieldName, DataObject $rec)
-    {
-        $component = $rec;
-
-        // We're dealing with relations here so we traverse the dot syntax
-        if (strpos($fieldName, '.') !== false) {
-            $relations = explode('.', $fieldName);
-            $fieldName = array_pop($relations);
-            foreach ($relations as $relation) {
-                // Inspect $component for element $relation
-                if ($component->hasMethod($relation)) {
-                    // Check nested method
-                    $component = $component->$relation();
-                } elseif ($component instanceof SS_List) {
-                    // Select adjacent relation from DataList
-                    $component = $component->relation($relation);
-                } elseif ($component instanceof DataObject && ($dbObject = $component->dbObject($relation))) {
-                    // Select db object
-                    $component = $dbObject;
-                } else {
-                    user_error("$relation is not a relation/field on ".get_class($component), E_USER_ERROR);
-                }
-            }
-        }
-
-        // Bail if the component is null
-        if (!$component) {
-            return null;
-        } elseif ($component instanceof SS_List) {
-            return $component->column($fieldName);
-        } elseif ($component->hasMethod($fieldName)) {
-            return $component->$fieldName();
-        } else {
-            return $component->$fieldName;
-        }
-    }
-
-    /**
-     * Trigger rebuild if needed
-     */
-    public function onBeforeWrite()
-    {
-        if ($this->isRebuilding || self::$disable_building) {
-            return;
-        }
-
-        $queueFields = interface_exists('QueuedJob') ? array() : false;
-
-        foreach ($this->getVFISpec() as $field => $spec) {
-            $rebuild = false;
-
-            if ($spec['DependsOn'] == self::DEPENDS_NONE) {
-                continue;
-            } elseif ($spec['DependsOn'] == self::DEPENDS_ALL) {
-                $rebuild = true;
-            } elseif (is_array($spec['DependsOn'])) {
-                foreach ($spec['DependsOn'] as $f) {
-                    if ($this->owner->isChanged($f)) {
-                        $rebuild = true;
-                        break;
-                    }
-                }
-            } else {
-                if ($this->owner->isChanged($spec['DependsOn'])) {
-                    $rebuild = true;
-                }
-            }
-
-            if ($rebuild) {
-                if ($queueFields === false) {
-                    $this->rebuildVFI($field);
-                } else {
-                    $queueFields[] = $field;
-                }
-            }
-        }
-
-        // if the queued-jobs module is present, then queue up the rebuild
-        if ($queueFields) {
-            $job = new VirtualFieldIndexQueuedJob($this->owner, $queueFields);
-            $job->triggerProcessing();
-        }
-    }
+				foreach ($chunk as $rec) {
+					$rec->rebuildVFI();
+				}
+			}
+		} else {
+			foreach (self::get_classes_with_vfi() as $c) {
+				self::build($c);
+			}
+		}
+	}
+
+	/**
+	 * Rebuild all vfi fields.
+	 */
+	public function rebuildVFI($field = '')
+	{
+		if ($field) {
+			$this->isRebuilding = true;
+			$spec   = $this->getVFISpec($field);
+			$fn     = $this->getVFIFieldName($field);
+			$val    = $this->getVFI($field, true);
+
+			if ($spec['Type'] == self::TYPE_LIST) {
+				if (is_object($val)) {
+					$val = $val->toArray();
+				}    // this would be an ArrayList or DataList
+				if (!is_array($val)) {
+					$val = array($val);
+				}        // this would be a scalar value
+				$val = self::encode_list($val);
+			} else {
+				if (is_array($val)) {
+					$val = (string)$val[0];
+				}    // if they give us an array, just take the first value
+				if (is_object($val)) {
+					$val = (string)$val->first();
+				}  // if a SS_List, take the first as well
+			}
+
+			if (Config::inst()->get('VirtualFieldIndex', 'fast_writes_enabled')) {
+				// NOTE: this is usually going to be bad practice, but if you
+				// have a lot of products and a lot of on...Write handlers that
+				// can get tedious really quick. This is just here as an option.
+				$table = '';
+				foreach ($this->owner->getClassAncestry() as $ancestor) {
+					if (DataObject::has_own_table($ancestor)) {
+						$sing = singleton($ancestor);
+						if ($sing->hasOwnTableDatabaseField($fn)) {
+							$table = $ancestor;
+							break;
+						}
+					}
+				}
+
+				if (!empty($table)) {
+					DB::query($sql = sprintf("UPDATE %s SET %s = '%s' WHERE ID = '%d'", $table, $fn, Convert::raw2sql($val), $this->owner->ID));
+					DB::query(sprintf("UPDATE %s_Live SET %s = '%s' WHERE ID = '%d'", $table, $fn, Convert::raw2sql($val), $this->owner->ID));
+					$this->owner->setField($fn, $val);
+				} else {
+					// if we couldn't figure out the right table, fall back to the old fashioned way
+					$this->owner->setField($fn, $val);
+					$this->owner->write();
+				}
+			} else {
+				$this->owner->setField($fn, $val);
+				$this->owner->write();
+			}
+			$this->isRebuilding = false;
+		} else {
+			// rebuild all fields if they didn't specify
+			foreach ($this->getVFISpec() as $field => $spec) {
+				$this->rebuildVFI($field);
+			}
+		}
+	}
+
+	/**
+	 * @param $name
+	 * @return string
+	 */
+	public function getVFIFieldName($name)
+	{
+		return 'VFI_' . $name;
+	}
+
+
+	/**
+	 * @param string $field [optional]
+	 * @return array|false
+	 */
+	public function getVFISpec($field = '')
+	{
+		$spec = self::get_vfi_spec($this->owner->class);
+		if ($field) {
+			return empty($spec[$field]) ? false : $spec[$field];
+		} else {
+			return $spec;
+		}
+	}
+
+
+	/**
+	 * @param string $field
+	 * @param bool   $fromSource [optional] - if true, it will regenerate the data from the source fields
+	 * @param bool   $forceIDs [optional] - if true, it will return an ID even if the norm is to return a DataObject
+	 * @return string|array|SS_List
+	 */
+	public function getVFI($field, $fromSource=false, $forceIDs=false)
+	{
+		$spec = $this->getVFISpec($field);
+		if (!$spec) {
+			return null;
+		}
+		if ($fromSource) {
+			if (is_array($spec['Source'])) {
+				$out = array();
+				foreach ($spec['Source'] as $src) {
+					$myOut = self::get_value($src, $this->owner);
+					if (is_array($myOut)) {
+						$out = array_merge($out, $myOut);
+					} elseif (is_object($myOut) && $myOut instanceof SS_List) {
+						$out = array_merge($out, $myOut->toArray());
+					} else {
+						$out[] = $myOut;
+					}
+				}
+				return $out;
+			} else {
+				return self::get_value($spec['Source'], $this->owner);
+			}
+		} else {
+			$val = $this->owner->getField($this->getVFIFieldName($field));
+			if ($spec['Type'] == self::TYPE_LIST) {
+				return self::decode_list($val, $forceIDs);
+			} else {
+				return $val;
+			}
+		}
+	}
+
+
+	/**
+	 * Template version
+	 * @param string $field
+	 * @return string|array|SS_List
+	 */
+	public function VFI($field)
+	{
+		return $this->getVFI($field);
+	}
+
+
+	/**
+	 * @param array $list
+	 * @return string
+	 */
+	protected static function encode_list(array $list)
+	{
+		// If we've got objects, encode them a little differently
+		if (count($list) > 0 && is_object($list[0])) {
+			$ids = array();
+			foreach ($list as $rec) {
+				$ids[] = $rec->ID;
+			}
+			$val = '>' . $list[0]->ClassName . '|' . implode('|', $ids) . '|';
+		} else {
+			$val = '|' . implode('|', $list) . '|';
+		}
+
+		return $val;
+	}
+
+
+	/**
+	 * @param string $val
+	 * @param bool   $forceIDs [optional] - if true encoded objects will not be returned as objects but as id's
+	 * @return array
+	 */
+	protected static function decode_list($val, $forceIDs=false)
+	{
+		if ($val[0] == '>') {
+			$firstBar = strpos($val, '|');
+			if ($firstBar < 3) {
+				return array();
+			}
+			$className = substr($val, 1, $firstBar-1);
+			$ids = explode('|', trim(substr($val, $firstBar), '|'));
+			return $forceIDs ? $ids : DataObject::get($className)->filter('ID', $ids)->toArray();
+		} else {
+			return explode('|', trim($val, '|'));
+		}
+	}
+
+
+	/**
+	 * This is largely borrowed from DataObject::relField, but
+	 * adapted to work with many-many and has-many fields.
+	 * @param string $fieldName
+	 * @param DataObject $rec
+	 * @return mixed
+	 */
+	protected static function get_value($fieldName, DataObject $rec)
+	{
+		$component = $rec;
+
+		// We're dealing with relations here so we traverse the dot syntax
+		if (strpos($fieldName, '.') !== false) {
+			$relations = explode('.', $fieldName);
+			$fieldName = array_pop($relations);
+			foreach ($relations as $relation) {
+				// Inspect $component for element $relation
+				if ($component->hasMethod($relation)) {
+					// Check nested method
+					$component = $component->$relation();
+				} elseif ($component instanceof SS_List) {
+					// Select adjacent relation from DataList
+					$component = $component->relation($relation);
+				} elseif ($component instanceof DataObject && ($dbObject = $component->dbObject($relation))) {
+					// Select db object
+					$component = $dbObject;
+				} else {
+					user_error("$relation is not a relation/field on ".get_class($component), E_USER_ERROR);
+				}
+			}
+		}
+
+		// Bail if the component is null
+		if (!$component) {
+			return null;
+		} elseif ($component instanceof SS_List) {
+			return $component->column($fieldName);
+		} elseif ($component->hasMethod($fieldName)) {
+			return $component->$fieldName();
+		} else {
+			return $component->$fieldName;
+		}
+	}
+
+	/**
+	 * Trigger rebuild if needed
+	 */
+	public function onBeforeWrite()
+	{
+		if ($this->isRebuilding || self::$disable_building) {
+			return;
+		}
+
+		$queueFields = interface_exists('QueuedJob') ? array() : false;
+
+		foreach ($this->getVFISpec() as $field => $spec) {
+			$rebuild = false;
+
+			if ($spec['DependsOn'] == self::DEPENDS_NONE) {
+				continue;
+			} elseif ($spec['DependsOn'] == self::DEPENDS_ALL) {
+				$rebuild = true;
+			} elseif (is_array($spec['DependsOn'])) {
+				foreach ($spec['DependsOn'] as $f) {
+					if ($this->owner->isChanged($f)) {
+						$rebuild = true;
+						break;
+					}
+				}
+			} else {
+				if ($this->owner->isChanged($spec['DependsOn'])) {
+					$rebuild = true;
+				}
+			}
+
+			if ($rebuild) {
+				if ($queueFields === false) {
+					$this->rebuildVFI($field);
+				} else {
+					$queueFields[] = $field;
+				}
+			}
+		}
+
+		// if the queued-jobs module is present, then queue up the rebuild
+		if ($queueFields) {
+			$job = new VirtualFieldIndexQueuedJob($this->owner, $queueFields);
+			$job->triggerProcessing();
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -89,7 +89,7 @@ 
         );
 
         foreach ($vfi_def as $field => $spec) {
-            $fn = 'VFI_' . $field;
+            $fn = 'VFI_'.$field;
             $out['db'][$fn] = isset($spec['DBField']) ? $spec['DBField'] : 'Varchar(255)';
             $out['indexes'][$fn] = true;
         }
@@ -158,7 +158,7 @@ 
      *
      * @param string $class [optional] - if not given all indexes will be rebuilt
      */
-    public static function build($class='')
+    public static function build($class = '')
     {
         if ($class) {
             $list   = DataObject::get($class);
@@ -248,7 +248,7 @@ 
      */
     public function getVFIFieldName($name)
     {
-        return 'VFI_' . $name;
+        return 'VFI_'.$name;
     }
 
 
@@ -273,7 +273,7 @@ 
      * @param bool   $forceIDs [optional] - if true, it will return an ID even if the norm is to return a DataObject
      * @return string|array|SS_List
      */
-    public function getVFI($field, $fromSource=false, $forceIDs=false)
+    public function getVFI($field, $fromSource = false, $forceIDs = false)
     {
         $spec = $this->getVFISpec($field);
         if (!$spec) {
@@ -330,9 +330,9 @@ 
             foreach ($list as $rec) {
                 $ids[] = $rec->ID;
             }
-            $val = '>' . $list[0]->ClassName . '|' . implode('|', $ids) . '|';
+            $val = '>'.$list[0]->ClassName.'|'.implode('|', $ids).'|';
         } else {
-            $val = '|' . implode('|', $list) . '|';
+            $val = '|'.implode('|', $list).'|';
         }
 
         return $val;
@@ -344,14 +344,14 @@ 
      * @param bool   $forceIDs [optional] - if true encoded objects will not be returned as objects but as id's
      * @return array
      */
-    protected static function decode_list($val, $forceIDs=false)
+    protected static function decode_list($val, $forceIDs = false)
     {
         if ($val[0] == '>') {
             $firstBar = strpos($val, '|');
             if ($firstBar < 3) {
                 return array();
             }
-            $className = substr($val, 1, $firstBar-1);
+            $className = substr($val, 1, $firstBar - 1);
             $ids = explode('|', trim(substr($val, $firstBar), '|'));
             return $forceIDs ? $ids : DataObject::get($className)->filter('ID', $ids)->toArray();
         } else {

code/ShopSearch.php

Doc Comments +1 added lines, -1 removed lines

@@ -267,7 +267,7 @@
 
     /**
      * @param string $str
-     * @return SS_Query
+     * @return SQLQuery
      */
     public function getSuggestQuery($str='')
     {

Indentation +350 added lines, -350 removed lines

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

Spacing +9 added lines, -9 removed lines

@@ -135,9 +135,9 @@ 
         }
 
         foreach ($cats as $cat) {
-            $out[$cat->ID] = $prefix . $cat->Title;
+            $out[$cat->ID] = $prefix.$cat->Title;
             if ($maxDepth > 1) {
-                $out += self::get_category_hierarchy($cat->ID, $prefix . $cat->Title . ' > ', $maxDepth - 1);
+                $out += self::get_category_hierarchy($cat->ID, $prefix.$cat->Title.' > ', $maxDepth - 1);
             }
         }
 
@@ -175,13 +175,13 @@ 
      * @param int $limit [optional]
      * @return ArrayData
      */
-    public function search(array $vars, $logSearch=true, $useFacets=true, $start=-1, $limit=-1)
+    public function search(array $vars, $logSearch = true, $useFacets = true, $start = -1, $limit = -1)
     {
         $qs_q   = $this->config()->get('qs_query');
         $qs_f   = $this->config()->get('qs_filters');
         $qs_ps  = $this->config()->get('qs_parent_search');
         $qs_t   = $this->config()->get('qs_title');
-        $qs_sort= $this->config()->get('qs_sort');
+        $qs_sort = $this->config()->get('qs_sort');
         if ($limit < 0) {
             $limit  = $this->config()->get('page_size');
         }
@@ -211,7 +211,7 @@ 
         if ($keywordRegex = $this->config()->get('keyword_filter_regex')) {
             $keywords = preg_replace($keywordRegex, '', $keywords);
         }
-        $results  = self::adapter()->searchFromVars($keywords, $filters, $facets, $start, $limit, $sort);
+        $results = self::adapter()->searchFromVars($keywords, $filters, $facets, $start, $limit, $sort);
 
         // massage the results a bit
         if (!empty($keywords) && !$results->hasValue('Query')) {
@@ -269,7 +269,7 @@ 
      * @param string $str
      * @return SS_Query
      */
-    public function getSuggestQuery($str='')
+    public function getSuggestQuery($str = '')
     {
         $hasResults = 'CASE WHEN max("SearchLog"."NumResults") > 0 THEN 1 ELSE 0 END';
         $searchCount = 'count(distinct "SearchLog"."ID")';
@@ -301,7 +301,7 @@ 
      * @param string $str
      * @return array
      */
-    public function suggest($str='')
+    public function suggest($str = '')
     {
         $adapter = self::adapter();
         if ($adapter->hasMethod('suggest')) {
@@ -349,7 +349,7 @@ 
                 ? $results['products']->getTotalItems()
                 : $results['products']->count();
 
-            $products   = array();
+            $products = array();
             foreach ($results['products'] as $prod) {
                 if (!$prod || !$prod->exists()) {
                     continue;
@@ -358,7 +358,7 @@ 
                 $thumb = ($img && $img->exists()) ? $img->getThumbnail() : null;
 
                 $json = array(
-                    'link'  => $prod->Link() . '?' . ShopSearch::config()->qs_source . '=' . urlencode(base64_encode(json_encode($searchVars))),
+                    'link'  => $prod->Link().'?'.ShopSearch::config()->qs_source.'='.urlencode(base64_encode(json_encode($searchVars))),
                     'title' => $prod->Title,
                     'desc'  => $prod->obj('Content')->Summary(),
                     'thumb' => $thumb ? $thumb->Link() : '',

code/ShopSearchControllerExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
 
     /**
      * @param SS_HTTPRequest $req
-     * @return string
+     * @return SS_HTTPResponse
      */
     public function search_suggest(SS_HTTPRequest $req)
     {

Indentation +70 added lines, -70 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -15,7 +15,7 @@ 
      */
     public function SearchForm()
     {
-        return ShopSearchForm::create($this->owner, 'SearchForm', $this->owner->Link() . 'search-suggest');
+        return ShopSearchForm::create($this->owner, 'SearchForm', $this->owner->Link().'search-suggest');
     }
 
 
@@ -32,7 +32,7 @@ 
         // convert the search results into usable json for search-as-you-type
         if (ShopSearch::config()->search_as_you_type_enabled) {
             $searchVars = $req->requestVars();
-            $searchVars[ ShopSearch::config()->qs_query ] = $searchVars['term'];
+            $searchVars[ShopSearch::config()->qs_query] = $searchVars['term'];
             unset($searchVars['term']);
             $results = ShopSearch::inst()->suggestWithResults($searchVars);
         } else {
@@ -43,7 +43,7 @@ 
 
         if ($callback) {
             $response->addHeader('Content-type', 'application/javascript');
-            $response->setBody($callback . '(' . json_encode($results) . ');');
+            $response->setBody($callback.'('.json_encode($results).');');
         } else {
             $response->addHeader('Content-type', 'application/json');
             $response->setBody(json_encode($results));

code/SearchLog.php

Indentation +50 added lines, -50 removed lines

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

code/ShopSearchAdapter.php

Spacing +1 added lines, -1 removed lines

@@ -17,5 +17,5 @@
      * @param string $sort [optional]
      * @return ArrayData - must contain at least 'Matches' with an list of data objects that match the search
      */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
+    public function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = '');
 }

Indentation +10 added lines, -10 removed lines

@@ -8,14 +8,14 @@
  */
 interface ShopSearchAdapter
 {
-    /**
-     * @param string $keywords
-     * @param array $filters [optional]
-     * @param array $facetSpec [optional]
-     * @param int $start [optional]
-     * @param int $limit [optional]
-     * @param string $sort [optional]
-     * @return ArrayData - must contain at least 'Matches' with an list of data objects that match the search
-     */
-    public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
+	/**
+	 * @param string $keywords
+	 * @param array $filters [optional]
+	 * @param array $facetSpec [optional]
+	 * @param int $start [optional]
+	 * @param int $limit [optional]
+	 * @param string $sort [optional]
+	 * @return ArrayData - must contain at least 'Matches' with an list of data objects that match the search
+	 */
+	public function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
 }

code/helpers/FacetedCategory.php

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

Indentation +134 added lines, -134 removed lines

@@ -16,138 +16,138 @@
  */
 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;
+	}
 }