markguinn / silverstripe-shop-search

code/helpers/FacetHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -322,7 +322,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
 	 */
@@ -359,7 +359,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) {

Indentation +12 added lines, -12 removed lines

@@ -1,16 +1,16 @@ 
 <?php
 /**
- * Adds methods for limited kinds of faceting using the silverstripe ORM.
- * This is used by the default ShopSearchSimple adapter but also can
- * be added to other contexts (such as ProductCategory).
- *
- * TODO: Facet class + subclasses
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 10.21.2013
- * @package shop_search
- * @subpackage helpers
- */
+	 * Adds methods for limited kinds of faceting using the silverstripe ORM.
+	 * This is used by the default ShopSearchSimple adapter but also can
+	 * be added to other contexts (such as ProductCategory).
+	 *
+	 * TODO: Facet class + subclasses
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 10.21.2013
+	 * @package shop_search
+	 * @subpackage helpers
+	 */
 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 */
@@ -380,7 +380,7 @@ 
 			->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"')
+				. ' AND "ProductAttributeValue"."TypeID" = "ProductAttributeType"."ID"')
 			->setOrderBy(array(
 				'"ProductAttributeType"."Label"' => 'ASC',
 				'"ProductAttributeValue"."Sort"' => 'ASC',

Spacing +16 added lines, -16 removed lines

@@ -59,7 +59,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());
 		if (is_string($sing)) $sing = singleton($sing);
 
@@ -148,7 +148,7 @@ 
 			}
 
 			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]['Type']))  $facets[$field]['Type'] = ShopSearch::FACET_TYPE_LINK;
 
 			if (empty($facets[$field]['Values'])) {
 				$facets[$field]['Values'] = array();
@@ -197,7 +197,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())) return new ArrayList();
 		$fasterMethod = (bool)$this->config()->faster_faceting;
@@ -340,9 +340,9 @@ 
 		$q = $q->setSelect(array())
 			->selectField('"ProductAttributeValue"."ID"', 'Value')
 			->selectField('"ProductAttributeValue"."Value"', 'Label')
-			->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
+			->selectField('count(distinct ' . $baseTable . '."ID")', 'Count')
 			->selectField('"ProductAttributeValue"."Sort"')
-			->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
+			->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')
@@ -352,7 +352,7 @@ 
 
 		$facet['Values'] = array();
 		foreach ($q as $row) {
-			$facet['Values'][ $row['Value'] ] = new ArrayData($row);
+			$facet['Values'][$row['Value']] = new ArrayData($row);
 		}
 	}
 
@@ -374,11 +374,11 @@ 
 			->selectField('"ProductAttributeType"."Label"', 'TypeLabel')
 			->selectField('"ProductAttributeValue"."ID"', 'Value')
 			->selectField('"ProductAttributeValue"."Value"', 'Label')
-			->selectField('count(distinct '.$baseTable.'."ID")', 'Count')
+			->selectField('count(distinct ' . $baseTable . '."ID")', 'Count')
 			->selectField('"ProductAttributeValue"."Sort"')
-			->addInnerJoin('Product_StaticAttributeTypes', $baseTable.'."ID" = "Product_StaticAttributeTypes"."ProductID"')
+			->addInnerJoin('Product_StaticAttributeTypes', $baseTable . '."ID" = "Product_StaticAttributeTypes"."ProductID"')
 			->addInnerJoin('ProductAttributeType', '"Product_StaticAttributeTypes"."ProductAttributeTypeID" = "ProductAttributeType"."ID"')
-			->addInnerJoin('Product_StaticAttributeValues', $baseTable.'."ID" = "Product_StaticAttributeValues"."ProductID"')
+			->addInnerJoin('Product_StaticAttributeValues', $baseTable . '."ID" = "Product_StaticAttributeValues"."ProductID"')
 			->addInnerJoin('ProductAttributeValue', '"Product_StaticAttributeValues"."ProductAttributeValueID" = "ProductAttributeValue"."ID"'
 			    . ' AND "ProductAttributeValue"."TypeID" = "ProductAttributeType"."ID"')
 			->setOrderBy(array(
@@ -395,11 +395,11 @@ 
 		$curFacet = null;
 		foreach ($q as $row) {
 			if ($curType != $row['TypeID']) {
-				if ($curType > 0) $facets['ATT'.$curType] = $curFacet;
+				if ($curType > 0) $facets['ATT' . $curType] = $curFacet;
 				$curType = $row['TypeID'];
 				$curFacet = array(
 					'Label'  => $row['TypeLabel'],
-					'Source' => 'ATT'.$curType,
+					'Source' => 'ATT' . $curType,
 					'Type'   => ShopSearch::FACET_TYPE_LINK,
 					'Values' => array(),
 				);
@@ -407,10 +407,10 @@ 
 
 			unset($row['TypeID']);
 			unset($row['TypeLabel']);
-			$curFacet['Values'][ $row['Value'] ] = new ArrayData($row);
+			$curFacet['Values'][$row['Value']] = new ArrayData($row);
 		}
 
-		if ($curType > 0) $facets['ATT'.$curType] = $curFacet;
+		if ($curType > 0) $facets['ATT' . $curType] = $curFacet;
 		return $facets;
 	}
 
@@ -532,7 +532,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;
 
 		foreach ($values as $value) {
@@ -576,14 +576,14 @@ 
 
 					// 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();
 
 							// 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) );
+							if ($p > -1) $value->Label = trim(substr($value->Label, $p + 1));
 
 							$curParent->Children->push($value);
 							break;

Braces +99 added lines, -33 removed lines

@@ -41,12 +41,18 @@ 
 	 * @return array
 	 */
 	public function scrubFilters($filters) {
-		if (!is_array($filters)) $filters = array();
+		if (!is_array($filters)) {
+			$filters = array();
+		}
 
 		foreach ($filters as $k => $v) {
-			if (empty($v)) unset($filters[$k]);
+			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));
+			if (is_string($v) && strpos($v, 'LIST~') === 0) {
+				$filters[$k] = explode(',', substr($v, 5));
+			}
 		}
 
 		return $filters;
@@ -60,8 +66,12 @@ 
 	 * @return DataList
 	 */
 	public function addFiltersToDataList($list, array $filters, $sing=null) {
-		if (!$sing) $sing = singleton($list->dataClass());
-		if (is_string($sing)) $sing = singleton($sing);
+		if (!$sing) {
+			$sing = singleton($list->dataClass());
+		}
+		if (is_string($sing)) {
+			$sing = singleton($sing);
+		}
 
 		if (!empty($filters)) {
 			foreach ($filters as $filterField => $filterVal) {
@@ -105,7 +115,9 @@ 
 				// Lists have to be handled a little differently
 				$f = $rec->getVFIFieldName($filterField) . ':PartialMatch';
 				if (is_array($filterVal)) {
-					foreach ($filterVal as &$val) $val = '|' . $val . '|';
+					foreach ($filterVal as &$val) {
+						$val = '|' . $val . '|';
+					}
 					return array($f => $filterVal);
 				} else {
 					return array($f => '|' . $filterVal . '|');
@@ -137,7 +149,9 @@ 
 	 * @return array
 	 */
 	public function expandFacetSpec(array $facetSpec) {
-		if (is_null($facetSpec)) return array();
+		if (is_null($facetSpec)) {
+			return array();
+		}
 		$facets = array();
 
 		foreach ($facetSpec as $field => $label) {
@@ -147,14 +161,20 @@ 
 				$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]['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 . ';');
+				if (is_string($vals)) {
+					$vals = eval('return ' . $vals . ';');
+				}
 				$facets[$field]['Values'] = array();
 				foreach ($vals as $val => $lbl) {
 					$facets[$field]['Values'][$val] = new ArrayData(array(
@@ -199,7 +219,9 @@ 
 	 */
 	public function buildFacets(SS_List $matches, array $facetSpec, $autoFacetAttributes=false) {
 		$facets = $this->expandFacetSpec($facetSpec);
-		if (!$autoFacetAttributes && (empty($facets) || !$matches || !$matches->count())) return new ArrayList();
+		if (!$autoFacetAttributes && (empty($facets) || !$matches || !$matches->count())) {
+			return new ArrayList();
+		}
 		$fasterMethod = (bool)$this->config()->faster_faceting;
 
 		// fill them in
@@ -212,8 +234,12 @@ 
 			// 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'];
+					if (isset($facet['RangeMin'])) {
+						$facet['MinValue'] = $facet['RangeMin'];
+					}
+					if (isset($facet['RangeMax'])) {
+						$facet['MaxValue'] = $facet['RangeMax'];
+					}
 				}
 
 				continue;
@@ -222,25 +248,37 @@ 
 			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 (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 (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 (!$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);
+					if (!is_array($fieldValue) && !$fieldValue instanceof SS_List) {
+						$fieldValue = array($fieldValue);
+					}
 
 					foreach ($fieldValue as $obj) {
-						if (empty($obj)) continue;
+						if (empty($obj)) {
+							continue;
+						}
 
 						// figure out the right label
 						if (is_object($obj) && $obj->hasMethod('Nice')) {
@@ -311,7 +349,9 @@ 
 		$out = new ArrayList();
 		$sortValues = self::config()->sort_facet_values;
 		foreach ($facets as $f) {
-			if ($sortValues) ksort($f['Values']);
+			if ($sortValues) {
+				ksort($f['Values']);
+			}
 			$f['Values'] = new ArrayList($f['Values']);
 			$out->push(new ArrayData($f));
 		}
@@ -335,7 +375,9 @@ 
 		}
 
 		$baseTable = $q->getFrom();
-		if (is_array($baseTable)) $baseTable = reset($baseTable);
+		if (is_array($baseTable)) {
+			$baseTable = reset($baseTable);
+		}
 
 		$q = $q->setSelect(array())
 			->selectField('"ProductAttributeValue"."ID"', 'Value')
@@ -367,7 +409,9 @@ 
 
 		// this is the easiest way to get SiteTree vs SiteTree_Live
 		$baseTable = $q->getFrom();
-		if (is_array($baseTable)) $baseTable = reset($baseTable);
+		if (is_array($baseTable)) {
+			$baseTable = reset($baseTable);
+		}
 
 		$q = $q->setSelect(array())
 			->selectField('"ProductAttributeType"."ID"', 'TypeID')
@@ -395,7 +439,9 @@ 
 		$curFacet = null;
 		foreach ($q as $row) {
 			if ($curType != $row['TypeID']) {
-				if ($curType > 0) $facets['ATT'.$curType] = $curFacet;
+				if ($curType > 0) {
+					$facets['ATT'.$curType] = $curFacet;
+				}
 				$curType = $row['TypeID'];
 				$curFacet = array(
 					'Label'  => $row['TypeLabel'],
@@ -410,7 +456,9 @@ 
 			$curFacet['Values'][ $row['Value'] ] = new ArrayData($row);
 		}
 
-		if ($curType > 0) $facets['ATT'.$curType] = $curFacet;
+		if ($curType > 0) {
+			$facets['ATT'.$curType] = $curFacet;
+		}
 		return $facets;
 	}
 
@@ -432,7 +480,9 @@ 
 			switch ($facet->Type) {
 				case ShopSearch::FACET_TYPE_RANGE:
 					$params = array_merge($baseParams, array());
-					if (!isset($params[$qs_f])) $params[$qs_f] = 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);
@@ -453,7 +503,9 @@ 
 						$params = array_merge($baseParams, array());
 
 						// add the filter for this value
-						if (!isset($params[$qs_f])) $params[$qs_f] = array();
+						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;
@@ -481,7 +533,9 @@ 
 
 		foreach ($children as $child) {
 			$out[$child->Value] = $child->Value;
-			if (!empty($child->Children)) $out += $this->getRecursiveChildValues($child->Children);
+			if (!empty($child->Children)) {
+				$out += $this->getRecursiveChildValues($child->Children);
+			}
 		}
 
 		return $out;
@@ -507,7 +561,9 @@ 
 					}
 				} else {
 					$filterVals = $filters[$facet->Source];
-					if (!is_array($filterVals)) $filterVals = array($filterVals);
+					if (!is_array($filterVals)) {
+						$filterVals = array($filterVals);
+					}
 					$this->updateCheckboxFacetState(
 						!empty($facet->NestedValues) ? $facet->NestedValues : $facet->Values,
 						$filterVals,
@@ -541,7 +597,9 @@ 
 					// 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;
+					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);
@@ -550,7 +608,9 @@ 
 				$value->Active = in_array($value->Value, $filterVals);
 			}
 
-			if ($value->Active) $out = true;
+			if ($value->Active) {
+				$out = true;
+			}
 		}
 
 		return $out;
@@ -571,19 +631,25 @@ 
 				$parentStack = array();
 
 				foreach ($facet->Values as $value) {
-					if (empty($value->Label)) continue;
+					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();
+							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) );
+							if ($p > -1) {
+								$value->Label = trim( substr($value->Label, $p + 1) );
+							}
 
 							$curParent->Children->push($value);
 							break;

code/helpers/HasStaticAttributes.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +9 added lines, -9 removed lines

@@ -1,14 +1,14 @@
 <?php
 /**
- * Extension for Product that allows static attributes in the same way
- * they're used for variations. I'm separating this out because it will
- * probably be useful in other projects.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 01.21.2014
- * @package Daywind
- * @subpackage extensions
- */
+	 * Extension for Product that allows static attributes in the same way
+	 * they're used for variations. I'm separating this out because it will
+	 * probably be useful in other projects.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 01.21.2014
+	 * @package Daywind
+	 * @subpackage extensions
+	 */
 class HasStaticAttributes extends DataExtension
 {
 	private static $many_many = array(

Spacing +4 added lines, -4 removed lines

@@ -38,8 +38,8 @@ 
 
 			$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 = 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);
@@ -141,8 +141,8 @@ 
 		// 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) {
+			foreach ($this->value as $id => $bool) {
+				if ($bool) {
 					$idList[$id] = $id;
 				}
 			}

Braces +21 added lines, -7 removed lines

@@ -70,7 +70,9 @@ 
 		}
 
 		foreach ($this->owner->StaticAttributeValues() as $val) {
-			if (!isset($list[$val->TypeID])) continue;
+			if (!isset($list[$val->TypeID])) {
+				continue;
+			}
 			$list[$val->TypeID]->ActiveValues->push($val);
 		}
 
@@ -86,7 +88,9 @@ 
 			$defaultAttributes = Config::inst()->get($this->owner->ClassName, 'default_attributes');
 			if (!empty($defaultAttributes)) {
 				$types = $this->owner->StaticAttributeTypes();
-				foreach ($defaultAttributes as $typeID) $types->add($typeID);
+				foreach ($defaultAttributes as $typeID) {
+					$types->add($typeID);
+				}
 			}
 		}
 	}
@@ -131,11 +135,17 @@ 
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		$fieldname  = $this->getFieldName();
-		if (empty($fieldname)) return;
+		if (empty($fieldname)) {
+			return;
+		}
 		$typeID     = $this->getAttributeTypeID();
-		if (empty($typeID)) return;
+		if (empty($typeID)) {
+			return;
+		}
 		$relation   = $record->$fieldname();
-		if (!$relation) return;
+		if (!$relation) {
+			return;
+		}
 		$relation   = $relation->filter('TypeID', $typeID);
 
 		// make a list of id's that should be there
@@ -160,10 +170,14 @@ 
 		}
 
 		// add
-		foreach ($idList as $id) $relation->add($id);
+		foreach ($idList as $id) {
+			$relation->add($id);
+		}
 
 		// remove
-		foreach ($toDelete as $id) $relation->removeByID($id);
+		foreach ($toDelete as $id) {
+			$relation->removeByID($id);
+		}
 	}
 
 

code/helpers/VirtualFieldIndex.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +8 added lines, -8 removed lines

@@ -57,14 +57,14 @@
 
 	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);
-    }
+	/**
+	 * @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.

Spacing +9 added lines, -9 removed lines

@@ -143,7 +143,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);
 			$count  = $list->count();
@@ -168,12 +168,12 @@ 
 			$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
+				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 (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')) {
@@ -242,7 +242,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) return null;
 		if ($fromSource) {
@@ -306,11 +306,11 @@ 
 	 * @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 {
@@ -345,7 +345,7 @@ 
 					// Select db object
 					$component = $dbObject;
 				} else {
-					user_error("$relation is not a relation/field on ".get_class($component), E_USER_ERROR);
+					user_error("$relation is not a relation/field on " . get_class($component), E_USER_ERROR);
 				}
 			}
 		}

Braces +49 added lines, -15 removed lines

@@ -62,7 +62,9 @@ 
      */
     public static function get_classes_with_vfi() {
         $vfi_def = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
-        if (!$vfi_def || !is_array($vfi_def)) return array();
+        if (!$vfi_def || !is_array($vfi_def)) {
+        	return array();
+        }
         return array_keys($vfi_def);
     }
 
@@ -75,7 +77,9 @@ 
 	 */
 	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();
+		if (!$vfi_def || !is_array($vfi_def)) {
+			return array();
+		}
 
 		$out = array(
 			'db'        => array(),
@@ -99,7 +103,9 @@ 
 	 */
 	public static function get_vfi_spec($class) {
 		$vfi_master = Config::inst()->get('VirtualFieldIndex', 'vfi_spec');
-		if (!$vfi_master || !is_array($vfi_master)) return array();
+		if (!$vfi_master || !is_array($vfi_master)) {
+			return array();
+		}
 
 		// merge in all the vfi's from ancestors as well
 		$vfi_def = array();
@@ -109,7 +115,9 @@ 
 				$vfi_def = $vfi_master[$c] + $vfi_def;
 			}
 		}
-		if (empty($vfi_def)) return array();
+		if (empty($vfi_def)) {
+			return array();
+		}
 
 		// convert shorthand to longhand
 		foreach ($vfi_def as $k => $v) {
@@ -129,8 +137,12 @@ 
 					'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;
+				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;
+				}
 			}
 		}
 
@@ -150,10 +162,14 @@ 
 			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();
+				foreach ($chunk as $rec) {
+					$rec->rebuildVFI();
+				}
 			}
 		} else {
-			foreach (self::get_classes_with_vfi() as $c) self::build($c);
+			foreach (self::get_classes_with_vfi() as $c) {
+				self::build($c);
+			}
 		}
 	}
 
@@ -168,12 +184,24 @@ 
 			$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
+				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 (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')) {
@@ -244,7 +272,9 @@ 
 	 */
 	public function getVFI($field, $fromSource=false, $forceIDs=false) {
 		$spec = $this->getVFISpec($field);
-		if (!$spec) return null;
+		if (!$spec) {
+			return null;
+		}
 		if ($fromSource) {
 			if (is_array($spec['Source'])) {
 				$out = array();
@@ -291,7 +321,9 @@ 
 		// 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;
+			foreach ($list as $rec) {
+				$ids[] = $rec->ID;
+			}
 			$val = '>' . $list[0]->ClassName . '|' . implode('|', $ids) . '|';
 		} else {
 			$val = '|' . implode('|', $list) . '|';
@@ -309,7 +341,9 @@ 
 	protected static function decode_list($val, $forceIDs=false) {
 		if ($val[0] == '>') {
 			$firstBar = strpos($val, '|');
-			if ($firstBar < 3) return array();
+			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();

code/ShopSearch.php

Doc Comments +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
 
 	/**
 	 * @param string $str
-	 * @return SS_Query
+	 * @return SQLQuery
 	 */
 	public function getSuggestQuery($str='') {
 		$hasResults = 'CASE WHEN max("SearchLog"."NumResults") > 0 THEN 1 ELSE 0 END';

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Fulltext search index for shop buyables
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 08.29.2013
- * @package shop_search
- */
+	 * Fulltext search index for shop buyables
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 08.29.2013
+	 * @package shop_search
+	 */
 class ShopSearch extends Object
 {
 	const FACET_TYPE_LINK       = 'link';

Spacing +7 added lines, -7 removed lines

@@ -171,12 +171,12 @@ 
 	 * @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');
 		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();
@@ -187,7 +187,7 @@ 
 		$sortOptions = $this->config()->get('sort_options');
 		$sort        = !empty($vars[$qs_sort]) ? $vars[$qs_sort] : '';
 		if (!isset($sortOptions[$sort])) {
-			$sort    = current(array_keys($sortOptions));
+			$sort = current(array_keys($sortOptions));
 		}
 
 		// figure out and scrub the filters
@@ -198,7 +198,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')) $results->Query = $keywords;
@@ -250,7 +250,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")';
 		$q = new SQLQuery();
@@ -281,7 +281,7 @@ 
 	 * @param string $str
 	 * @return array
 	 */
-	public function suggest($str='') {
+	public function suggest($str = '') {
 		$adapter = self::adapter();
 		if ($adapter->hasMethod('suggest')) {
 			return $adapter->suggest($str);
@@ -327,7 +327,7 @@ 
 				? $results['products']->getTotalItems()
 				: $results['products']->count();
 
-			$products   = array();
+			$products = array();
 			foreach ($results['products'] as $prod) {
 				if (!$prod || !$prod->exists()) continue;
 				$img = $prod->hasMethod('ProductImage') ? $prod->ProductImage() : $prod->Image();

Braces +25 added lines, -8 removed lines

@@ -177,11 +177,20 @@ 
 		$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'
+		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;
+		if (!is_array($facets)) {
+			$facets = array();
+		}
+		if (empty($limit)) {
+			$limit = -1;
+		}
 
 		// figure out and scrub the sort
 		$sortOptions = $this->config()->get('sort_options');
@@ -201,9 +210,15 @@ 
 		$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 (!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()
@@ -329,7 +344,9 @@ 
 
 			$products   = array();
 			foreach ($results['products'] as $prod) {
-				if (!$prod || !$prod->exists()) continue;
+				if (!$prod || !$prod->exists()) {
+					continue;
+				}
 				$img = $prod->hasMethod('ProductImage') ? $prod->ProductImage() : $prod->Image();
 				$thumb = ($img && $img->exists()) ? $img->getThumbnail() : null;
 

code/ShopSearchControllerExtension.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Adds SearchForm and results methods to the controller.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 08.29.2013
- * @package shop_search
- */
+	 * Adds SearchForm and results methods to the controller.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 08.29.2013
+	 * @package shop_search
+	 */
 class ShopSearchControllerExtension extends Extension
 {
 	private static $allowed_actions = array('SearchForm', 'results', 'search_suggest');

Spacing +2 added lines, -2 removed lines

@@ -30,7 +30,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 {
@@ -56,7 +56,7 @@ 
 	 */
 	public function onAfterInit() {
 		$req = $this->owner->getRequest();
-		$src = $req->requestVar( Config::inst()->get('ShopSearch', 'qs_source') );
+		$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');

code/ShopSearchAdapter.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Interface for shop search drivers.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 09.03.2013
- * @package shop_search
- */
+	 * Interface for shop search drivers.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 09.03.2013
+	 * @package shop_search
+	 */
 interface ShopSearchAdapter
 {
 	/**

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
 	 */
-	function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='');
+	function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = '');
 }

code/ShopSearchAjax.php

Indentation +7 added lines, -7 removed lines

@@ -1,12 +1,12 @@
 <?php
 /**
- * Pending some changes introduced to the core shop module, this will supply
- * some standard, easily overridable ajax features.
- *
- * @author Mark Guinn <mark@adaircreative.com>
- * @date 07.21.2014
- * @package shop_search
- */
+	 * Pending some changes introduced to the core shop module, this will supply
+	 * some standard, easily overridable ajax features.
+	 *
+	 * @author Mark Guinn <mark@adaircreative.com>
+	 * @date 07.21.2014
+	 * @package shop_search
+	 */
 class ShopSearchAjax extends Extension
 {
 	/**

Braces +3 added lines, -1 removed lines

@@ -17,7 +17,9 @@
 	 */
 	public function updateSearchResultsResponse(&$request, &$response, $results, $data) {
 		if ($request->isAjax() && $this->owner->hasExtension('AjaxControllerExtension')) {
-			if (!$response) $response = $this->owner->getAjaxResponse();
+			if (!$response) {
+				$response = $this->owner->getAjaxResponse();
+			}
 			$response->addRenderContext('RESULTS', $results);
 			$response->pushRegion('SearchResults', $results);
 			$response->pushRegion('SearchHeader', $results);

code/ShopSearchForm.php

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
 
 			$emptyString = self::config()->category_empty_string;
 			if ($emptyString !== 'NONE') {
-				$catField->setEmptyString(_t('ShopSearch.'.$emptyString, $emptyString));
+				$catField->setEmptyString(_t('ShopSearch.' . $emptyString, $emptyString));
 			}
 
 			$fields->push($catField);

Braces +6 added lines, -2 removed lines

@@ -29,7 +29,9 @@ 
 	function __construct($controller, $method, $suggestURL = '') {
 		$searchField = TextField::create('q', '');
 		$searchField->setAttribute('placeholder', _t('ShopSearch.SEARCH', 'Search'));
-		if ($suggestURL) $searchField->setAttribute('data-suggest-url', $suggestURL);
+		if ($suggestURL) {
+			$searchField->setAttribute('data-suggest-url', $suggestURL);
+		}
 
 		$fields = FieldList::create($searchField);
 		if (!self::config()->disable_category_dropdown) {
@@ -48,7 +50,9 @@ 
 
 		$this->setFormMethod('GET');
 		$this->disableSecurityToken();
-		if ($c = self::config()->css_classes) $this->addExtraClass($c);
+		if ($c = self::config()->css_classes) {
+			$this->addExtraClass($c);
+		}
 
 		Requirements::css(SHOP_SEARCH_FOLDER . '/css/ShopSearch.css');
 

code/adapters/ShopSearchMysql.php

Spacing +5 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
 	 * @param string $sort [optional]
 	 * @return ArrayData
 	 */
-	function searchFromVars($keywords, array $filters=array(), array $facetSpec=array(), $start=-1, $limit=-1, $sort='') {
+	function searchFromVars($keywords, array $filters = array(), array $facetSpec = array(), $start = -1, $limit = -1, $sort = '') {
 		$searchable = ShopSearch::get_searchable_classes();
 		$matches = new ArrayList;
 
@@ -32,13 +32,13 @@ 
 			$filter = array();
 
 			// Use parametrized query if SilverStripe >= 3.2
-			if(SHOP_SEARCH_IS_SS32){
-				foreach($keywordFields as $indexFields){
+			if (SHOP_SEARCH_IS_SS32) {
+				foreach ($keywordFields as $indexFields) {
 					$filter[] = array("MATCH ($indexFields) AGAINST (?)" => $keywords);
 				}
 				$list = $list->whereAny($filter);
 			} else {
-				foreach($keywordFields as $indexFields){
+				foreach ($keywordFields as $indexFields) {
 					$filter[] = sprintf("MATCH ($indexFields) AGAINST ('%s')", Convert::raw2sql($keywords));
 				}
 				// join all the filters with an "OR" statement
@@ -78,7 +78,7 @@ 
 			}
 		}
 
-		if(count($indexList) === 0){
+		if (count($indexList) === 0) {
 			throw new Exception("Class $className does not appear to have any fulltext indexes");
 		}