gordonbanderson / silverstripe-elastica

tests/ElasticsearchTestBase.php

Doc Comments +11 added lines

@@ -132,6 +132,10 @@ 
 	}
 
 
+	/**
+	 * @param integer $depth
+	 * @param string $parentKey
+	 */
 	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
 		$prefix = str_repeat("\t",$depth);
 		echo "\t{$prefix}'$parentKey' => array(\n";
@@ -160,6 +164,10 @@ 
 	/*
 	Helper methods for testing CMS fields
 	 */
+
+	/**
+	 * @param string $tabName
+	 */
 	public function checkTabExists($fields, $tabName) {
 		echo "Searching for tab $tabName\n";
 		$tab = $fields->findOrMakeTab("Root.{$tabName}");
@@ -184,6 +192,9 @@ 
 	}
 
 
+	/**
+	 * @param string $fieldName
+	 */
 	public function checkFieldExists($tab,$fieldName) {
 		$fields = $tab->Fields();
 		echo "TAB:{$tab->Name}\n";

Indentation +4 added lines, -4 removed lines

@@ -208,11 +208,11 @@
 	 */
 	public function invokeMethod(&$object, $methodName, array $parameters = array())
 	{
-	    $reflection = new \ReflectionClass(get_class($object));
-	    $method = $reflection->getMethod($methodName);
-	    $method->setAccessible(true);
+		$reflection = new \ReflectionClass(get_class($object));
+		$method = $reflection->getMethod($methodName);
+		$method->setAccessible(true);
 
-	    return $method->invokeArgs($object, $parameters);
+		return $method->invokeArgs($object, $parameters);
 	}
 
 

Spacing +19 added lines, -19 removed lines

@@ -9,8 +9,8 @@ 
 	public static $ignoreFixtureFileFor = array();
 
 	protected $extraDataObjects = array(
-		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
-		'SearchableTestFatherPage','SearchableTestGrandFatherPage','AutoCompleteOption'
+		'SearchableTestPage', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO', 'FlickrTagTO',
+		'SearchableTestFatherPage', 'SearchableTestGrandFatherPage', 'AutoCompleteOption'
 	);
 
 
@@ -39,7 +39,7 @@ 
 
 		// this needs to be called in order to create the list of searchable
 		// classes and fields that are available.  Simulates part of a build
-		$classes = array('SearchableTestPage','SiteTree','Page','FlickrPhotoTO','FlickrSetTO',
+		$classes = array('SearchableTestPage', 'SiteTree', 'Page', 'FlickrPhotoTO', 'FlickrSetTO',
 			'FlickrTagTO', 'FlickrAuthorTO');
 		$this->requireDefaultRecordsFrom = $classes;
 
@@ -61,13 +61,13 @@ 
 		$orig_fixture_file = static::$fixture_file;
 
 		foreach (static::$ignoreFixtureFileFor as $testPattern) {
-			$pattern = '/'.$testPattern.'/';
+			$pattern = '/' . $testPattern . '/';
 			if (preg_match($pattern, $this->getName())) {
 				static::$fixture_file = null;
 			}
 		}
 
-		echo "\n\n\n\nEXECUTING TEST {$this->getName()}, FIXTURES=".static::$fixture_file."\n";
+		echo "\n\n\n\nEXECUTING TEST {$this->getName()}, FIXTURES=" . static::$fixture_file . "\n";
 
 		parent::setUp();
 		static::$fixture_file = $orig_fixture_file;
@@ -97,53 +97,53 @@ 
 			// temporarily disable Elasticsearch indexing, it will be done in a batch
 			$page->IndexingOff = true;
 
-			echo "Publishing ".$page->Title."\n";
-			$page->publish('Stage','Live');
+			echo "Publishing " . $page->Title . "\n";
+			$page->publish('Stage', 'Live');
 		}
 	}
 
 
 	public function generateAssertionsFromArray($toAssert) {
-		echo '$expected = array('."\n";
+		echo '$expected = array(' . "\n";
 		foreach ($toAssert as $key => $value) {
 			$escValue = str_replace("'", '\\\'', $value);
 			echo "'$key' => '$escValue',\n";
 		}
 		echo ");\n";
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	public function generateAssertionsFromArray1D($toAssert) {
-		echo '$expected = array('."\n";
+		echo '$expected = array(' . "\n";
 		foreach ($toAssert as $key => $value) {
 			$escValue = str_replace("'", '\\\'', $value);
 			echo "'$escValue',";
 		}
 		echo ");\n";
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	public function generateAssertionsFromArrayRecurse($toAssert) {
 		echo '$expected = ';
-			$this->recurseArrayAssertion($toAssert,1, 'FIXME');
-		echo '$this->assertEquals($expected, $somevar);'."\n";
+			$this->recurseArrayAssertion($toAssert, 1, 'FIXME');
+		echo '$this->assertEquals($expected, $somevar);' . "\n";
 	}
 
 
 	private function recurseArrayAssertion($toAssert, $depth, $parentKey) {
-		$prefix = str_repeat("\t",$depth);
+		$prefix = str_repeat("\t", $depth);
 		echo "\t{$prefix}'$parentKey' => array(\n";
 		$ctr = 0;
 		$len = sizeof(array_keys($toAssert));
 		foreach ($toAssert as $key => $value) {
 			if (is_array($value)) {
-				$this->recurseArrayAssertion($value, $depth+1, $key);
+				$this->recurseArrayAssertion($value, $depth + 1, $key);
 			} else {
 				$escValue = str_replace("'", '\\\'', $value);
 				$comma = ',';
-				if ($ctr == $len-1) {
+				if ($ctr == $len - 1) {
 					$comma = '';
 				}
 				echo "\t\t$prefix'$key' => '$escValue'$comma\n";
@@ -184,11 +184,11 @@ 
 	}
 
 
-	public function checkFieldExists($tab,$fieldName) {
+	public function checkFieldExists($tab, $fieldName) {
 		$fields = $tab->Fields();
 		echo "TAB:{$tab->Name}\n";
 		foreach ($fields as $fi) {
-			echo "NAME:".$fi->Name."\n";
+			echo "NAME:" . $fi->Name . "\n";
 		}
 		$field = $tab->fieldByName($fieldName);
 		$this->assertTrue($field != null);
@@ -225,7 +225,7 @@ 
 			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
 		}
 
-		$this->assertEquals($expectedAmount,$numberDocsInIndex);
+		$this->assertEquals($expectedAmount, $numberDocsInIndex);
 	}
 
 	/*

tests/mock/Translatable.php

Doc Comments +2 added lines, -3 removed lines

@@ -282,7 +282,6 @@ 
 	 * to "auto-filter" all SELECT queries by this language.
 	 * See {@link disable_locale_filter()} on how to override this behaviour temporarily.
 	 *
-	 * @param string $lang New reading language.
 	 */
 	static function set_current_locale($locale) {
 		self::$current_locale = $locale;
@@ -373,7 +372,7 @@ 
 	 * Check if a given SQLQuery filters on the Locale field
 	 *
 	 * @param SQLQuery $query
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	protected function filtersOnLocale($query) {
 		foreach($query->getWhere() as $condition) {
@@ -536,7 +535,7 @@ 
 	 * This ID might equal the record ID, but doesn't have to -
 	 * it just points to one "original" record in the list.
 	 *
-	 * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
+	 * @return false|string Numeric ID of the translationgroup in the <classname>_translationgroup table
 	 */
 	public function getTranslationGroup() {
 		if(!$this->owner->exists()) return false;

Spacing +51 added lines, -51 removed lines

@@ -344,14 +344,14 @@ 
 		parent::setOwner($owner, $ownerBaseClass);
 
 		// setting translatable fields by inspecting owner - this should really be done in the constructor
-		if($this->owner && $this->translatableFields === null) {
+		if ($this->owner && $this->translatableFields === null) {
 			$this->translatableFields = array_merge(
 				array_keys($this->owner->db()),
 				array_keys($this->owner->has_many()),
 				array_keys($this->owner->many_many())
 			);
 			foreach (array_keys($this->owner->has_one()) as $fieldname) {
-				$this->translatableFields[] = $fieldname.'ID';
+				$this->translatableFields[] = $fieldname . 'ID';
 			}
 		}
 	}
@@ -376,8 +376,8 @@ 
 	 * @return boolean
 	 */
 	protected function filtersOnLocale($query) {
-		foreach($query->getWhere() as $condition) {
-			if(preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) return true;
+		foreach ($query->getWhere() as $condition) {
+			if (preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) return true;
 		}
 	}
 
@@ -389,18 +389,18 @@ 
 	 *
 	 * Use {@link disable_locale_filter()} to temporarily disable this "auto-filtering".
 	 */
-	public function augmentSQL(SQLQuery &$query, DataQuery $dataQuery = null) {
+	public function augmentSQL(SQLQuery & $query, DataQuery $dataQuery = null) {
 		// If the record is saved (and not a singleton), and has a locale,
 		// limit the current call to its locale. This fixes a lot of problems
 		// with other extensions like Versioned
-		if($this->owner->ID && !empty($this->owner->Locale)) {
+		if ($this->owner->ID && !empty($this->owner->Locale)) {
 			$locale = $this->owner->Locale;
 		} else {
 			$locale = Translatable::get_current_locale();
 		}
 
 		$baseTable = ClassInfo::baseDataClass($this->owner->class);
-		if(
+		if (
 			$locale
 			// unless the filter has been temporarily disabled
 			&& self::locale_filter_enabled()
@@ -415,13 +415,13 @@ 
 			// call or through custom SQL filters)
 			&& !$this->filtersOnLocale($query)
 			//&& !$query->filtersOnFK()
-		)  {
+		) {
 			$qry = sprintf('"%s"."Locale" = \'%s\'', $baseTable, Convert::raw2sql($locale));
 			$query->addWhere($qry);
 		}
 	}
 
-	function augmentDataQueryCreation(SQLQuery &$sqlQuery, DataQuery &$dataQuery) {
+	function augmentDataQueryCreation(SQLQuery & $sqlQuery, DataQuery & $dataQuery) {
 		$enabled = self::locale_filter_enabled();
 		$dataQuery->setQueryParam(self::QUERY_LOCALE_FILTER_ENABLED, $enabled);
 	}
@@ -429,7 +429,7 @@ 
 	 // FIXME - NO TEST COVERAGE BUT REQUIRED
 	function augmentDatabase() {
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
-		if($this->owner->class != $baseDataClass) return;
+		if ($this->owner->class != $baseDataClass) return;
 
 		$fields = array(
 			'OriginalID' => 'Int',
@@ -445,7 +445,7 @@ 
 
 		// Remove 2.2 style tables
 		DB::dontRequireTable("{$baseDataClass}_lang");
-		if($this->owner->hasExtension('Versioned')) {
+		if ($this->owner->hasExtension('Versioned')) {
 			DB::dontRequireTable("{$baseDataClass}_lang_Live");
 			DB::dontRequireTable("{$baseDataClass}_lang_versions");
 		}
@@ -456,7 +456,7 @@ 
 	 */
 	public function requireDefaultRecords() {
 		// @todo This relies on the Locale attribute being on the base data class, and not any subclasses
-		if($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) return false;
+		if ($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) return false;
 
 		// Permissions: If a group doesn't have any specific TRANSLATE_<locale> edit rights,
 		// but has CMS_ACCESS_CMSMain (general CMS access), then assign TRANSLATE_ALL permissions as a default.
@@ -468,14 +468,14 @@ 
 			'CMS_ACCESS_LeftAndMain',
 			'ADMIN'
 		));
-		if($groups) foreach($groups as $group) {
+		if ($groups) foreach ($groups as $group) {
 			$codes = $group->Permissions()->column('Code');
 			$hasTranslationCode = false;
-			foreach($codes as $code) {
-				if(preg_match('/^TRANSLATE_/', $code)) $hasTranslationCode = true;
+			foreach ($codes as $code) {
+				if (preg_match('/^TRANSLATE_/', $code)) $hasTranslationCode = true;
 			}
 			// Only add the code if no more restrictive code exists
-			if(!$hasTranslationCode) Permission::grant($group->ID, 'TRANSLATE_ALL');
+			if (!$hasTranslationCode) Permission::grant($group->ID, 'TRANSLATE_ALL');
 		}
 
 		// If the Translatable extension was added after the first records were already
@@ -485,7 +485,7 @@ 
 			'SELECT "ID" FROM "%s" WHERE "Locale" IS NULL OR "Locale" = \'\'',
 			ClassInfo::baseDataClass($this->owner->class)
 		))->column();
-		if(!$idsWithoutLocale) return;
+		if (!$idsWithoutLocale) return;
 
 
 
@@ -502,13 +502,13 @@ 
 	 * @param boolean $overwrite
 	 */
 	public function addTranslationGroup($originalID, $overwrite = false) {
-		if(!$this->owner->exists()) return false;
+		if (!$this->owner->exists()) return false;
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		$existingGroupID = $this->getTranslationGroup($originalID);
 
 		// Remove any existing groups if overwrite flag is set
-		if($existingGroupID && $overwrite) {
+		if ($existingGroupID && $overwrite) {
 			$sql = sprintf(
 				'DELETE FROM "%s_translationgroups" WHERE "TranslationGroupID" = %d AND "OriginalID" = %d',
 				$baseDataClass,
@@ -520,7 +520,7 @@ 
 		}
 
 		// Add to group (only if not in existing group or $overwrite flag is set)
-		if(!$existingGroupID) {
+		if (!$existingGroupID) {
 			$sql = sprintf(
 				'INSERT INTO "%s_translationgroups" ("TranslationGroupID","OriginalID") VALUES (%d,%d)',
 				$baseDataClass,
@@ -539,7 +539,7 @@ 
 	 * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
 	 */
 	public function getTranslationGroup() {
-		if(!$this->owner->exists()) return false;
+		if (!$this->owner->exists()) return false;
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		return DB::query(
@@ -587,7 +587,7 @@ 
 		// of the content, as a "single language" website might be expanded
 		// later on. See {@link requireDefaultRecords()} for batch setting
 		// of empty Locale columns on each dev/build call.
-		if(!$this->owner->Locale) {
+		if (!$this->owner->Locale) {
 			$this->owner->Locale = Translatable::get_current_locale();
 		}
 
@@ -597,12 +597,12 @@ 
 		// Caution: This logic is very sensitve to infinite loops when translation status isn't determined properly
 		// If a parent for the newly written translation was existing before this
 		// onBeforeWrite() call, it will already have been linked correctly through createTranslation()
-		if(
+		if (
 			class_exists('SiteTree')
 			&& $this->owner->hasField('ParentID')
 			&& $this->owner instanceof SiteTree
 		) {
-			if(
+			if (
 				!$this->owner->ID
 				&& $this->owner->ParentID
 				&& !$this->owner->Parent()->hasTranslation($this->owner->Locale)
@@ -614,7 +614,7 @@ 
 
 		// Has to be limited to the default locale, the assumption is that the "page type"
 		// dropdown is readonly on all translations.
-		if($this->owner->ID && $this->owner->Locale == Translatable::default_locale()) {
+		if ($this->owner->ID && $this->owner->Locale == Translatable::default_locale()) {
 			$changedFields = $this->owner->getChangedFields();
 			$changed = isset($changedFields['ClassName']);
 
@@ -642,11 +642,11 @@ 
 				}
 			}
 
-			if($changed) {
+			if ($changed) {
 				$this->owner->ClassName = $changedFields['ClassName']['before'];
 				$translations = $this->owner->getTranslations();
 				$this->owner->ClassName = $changedFields['ClassName']['after'];
-				if($translations) foreach($translations as $translation) {
+				if ($translations) foreach ($translations as $translation) {
 					$translation->setClassName($this->owner->ClassName);
 					$translation = $translation->newClassInstance($translation->ClassName);
 					$translation->populateDefaults();
@@ -657,7 +657,7 @@ 
 		}
 
 		// see onAfterWrite()
-		if(!$this->owner->ID) {
+		if (!$this->owner->ID) {
 			$this->owner->_TranslatableIsNewRecord = true;
 		}
 	}
@@ -665,12 +665,12 @@ 
 	function onAfterWrite() {
 		// hacky way to determine if the record was created in the database,
 		// or just updated
-		if($this->owner->_TranslatableIsNewRecord) {
+		if ($this->owner->_TranslatableIsNewRecord) {
 			// this would kick in for all new records which are NOT
 			// created through createTranslation(), meaning they don't
 			// have the translation group automatically set.
 			$translationGroupID = $this->getTranslationGroup();
-			if(!$translationGroupID) {
+			if (!$translationGroupID) {
 				$this->addTranslationGroup(
 					$this->owner->_TranslationGroupID ? $this->owner->_TranslationGroupID : $this->owner->ID
 				);
@@ -705,7 +705,7 @@ 
 
 		// Find the locale language-independent of the page
 		self::disable_locale_filter();
-		$default = SiteTree::get()->where(sprintf (
+		$default = SiteTree::get()->where(sprintf(
 			'"URLSegment" = \'%s\'%s',
 			Convert::raw2sql($URLSegment),
 			(is_int($parentID) ? " AND \"ParentID\" = $parentID" : null)
@@ -721,7 +721,7 @@ 
 	public function updateRelativeLink(&$base, &$action) {
 		// Prevent home pages for non-default locales having their urlsegments
 		// reduced to the site root.
-		if($base === null && $this->owner->Locale != self::default_locale()){
+		if ($base === null && $this->owner->Locale != self::default_locale()) {
 			$base = $this->owner->URLSegment;
 		}
 	}
@@ -745,14 +745,14 @@ 
 	 * @return DataObjectSet
 	 */
 	function getTranslations($locale = null, $stage = null) {
-		if(!$this->owner->exists()) return new ArrayList();
+		if (!$this->owner->exists()) return new ArrayList();
 
 		// HACK need to disable language filtering in augmentSQL(),
 		// as we purposely want to get different language
 		// also save state of locale-filter, revert to this state at the
 		// end of this method
 		$localeFilterEnabled = false;
-		if(self::locale_filter_enabled()) {
+		if (self::locale_filter_enabled()) {
 			self::disable_locale_filter();
 			$localeFilterEnabled = true;
 		}
@@ -761,7 +761,7 @@ 
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		$filter = sprintf('"%s_translationgroups"."TranslationGroupID" = %d', $baseDataClass, $translationGroupID);
-		if($locale) {
+		if ($locale) {
 			$filter .= sprintf(' AND "%s"."Locale" = \'%s\'', $baseDataClass, Convert::raw2sql($locale));
 		} else {
 			// exclude the language of the current owner
@@ -769,15 +769,15 @@ 
 		}
 		$currentStage = Versioned::current_stage();
 		$joinOnClause = sprintf('"%s_translationgroups"."OriginalID" = "%s"."ID"', $baseDataClass, $baseDataClass);
-		if($this->owner->hasExtension("Versioned")) {
-			if($stage) Versioned::reading_stage($stage);
+		if ($this->owner->hasExtension("Versioned")) {
+			if ($stage) Versioned::reading_stage($stage);
 			$translations = Versioned::get_by_stage(
 				$baseDataClass,
 				Versioned::current_stage(),
 				$filter,
 				null
 			)->leftJoin("{$baseDataClass}_translationgroups", $joinOnClause);
-			if($stage) Versioned::reading_stage($currentStage);
+			if ($stage) Versioned::reading_stage($currentStage);
 		} else {
 			$class = $this->owner->class;
 			$translations = $baseDataClass::get()
@@ -786,7 +786,7 @@ 
 		}
 
 		// only re-enable locale-filter if it was enabled at the beginning of this method
-		if($localeFilterEnabled) {
+		if ($localeFilterEnabled) {
 			self::enable_locale_filter();
 		}
 
@@ -827,7 +827,7 @@ 
 	 */
 	static function get_existing_content_languages($className = 'SiteTree', $where = '') {
 		$baseTable = ClassInfo::baseDataClass($className);
-		$query = new SQLQuery("Distinct \"Locale\"","\"$baseTable\"",$where, '', "\"Locale\"");
+		$query = new SQLQuery("Distinct \"Locale\"", "\"$baseTable\"", $where, '', "\"Locale\"");
 		$dbLangs = $query->execute()->column();
 		$langlist = array_merge((array)Translatable::default_locale(), (array)$dbLangs);
 		$returnMap = array();
@@ -836,8 +836,8 @@ 
 			Config::inst()->get('i18n', 'common_locales')
 		);
 		foreach ($langlist as $langCode) {
-			if($langCode && isset($allCodes[$langCode])) {
-				if(is_array($allCodes[$langCode])) {
+			if ($langCode && isset($allCodes[$langCode])) {
+				if (is_array($allCodes[$langCode])) {
 					$returnMap[$langCode] = $allCodes[$langCode]['name'];
 				} else {
 					$returnMap[$langCode] = $allCodes[$langCode];
@@ -860,8 +860,8 @@ 
 		$original = SiteTree::get_by_link(RootURLController::config()->default_homepage_link);
 		self::set_current_locale($originalLocale);
 
-		if($original) {
-			if($translation = $original->getTranslation($locale)) return trim($translation->RelativeLink(true), '/');
+		if ($original) {
+			if ($translation = $original->getTranslation($locale)) return trim($translation->RelativeLink(true), '/');
 		}
 	}
 
@@ -870,7 +870,7 @@ 
 	 * @deprecated 2.4 Use {@link Translatable::get_homepage_link_by_locale()}
 	 */
 	static function get_homepage_urlsegment_by_locale($locale) {
-		user_error (
+		user_error(
 			'Translatable::get_homepage_urlsegment_by_locale() is deprecated, please use get_homepage_link_by_locale()',
 			E_USER_NOTICE
 		);
@@ -884,7 +884,7 @@ 
 	 * Return a piece of text to keep DataObject cache keys appropriately specific
 	 */
 	function cacheKeyComponent() {
-		return 'locale-'.self::get_current_locale();
+		return 'locale-' . self::get_current_locale();
 	}
 
 	/**
@@ -895,18 +895,18 @@ 
      */
 	public function augmentValidURLSegment() {
 		$reEnableFilter = false;
-		if(!Config::inst()->get('Translatable', 'enforce_global_unique_urls')) {
+		if (!Config::inst()->get('Translatable', 'enforce_global_unique_urls')) {
 			self::enable_locale_filter();
-		} elseif(self::locale_filter_enabled()) {
+		} elseif (self::locale_filter_enabled()) {
 			self::disable_locale_filter();
 			$reEnableFilter = true;
 		}
 
-		$IDFilter = ($this->owner->ID) ? "AND \"SiteTree\".\"ID\" <> {$this->owner->ID}" :  null;
+		$IDFilter = ($this->owner->ID) ? "AND \"SiteTree\".\"ID\" <> {$this->owner->ID}" : null;
 		$parentFilter = null;
 
 		if (Config::inst()->get('SiteTree', 'nested_urls')) {
-			if($this->owner->ParentID) {
+			if ($this->owner->ParentID) {
 				$parentFilter = " AND \"SiteTree\".\"ParentID\" = {$this->owner->ParentID}";
 			} else {
 				$parentFilter = ' AND "SiteTree"."ParentID" = 0';
@@ -916,7 +916,7 @@ 
 		$existingPage = SiteTree::get()
 			// disable get_one cache, as this otherwise may pick up results from when locale_filter was on
 			->where("\"URLSegment\" = '{$this->owner->URLSegment}' $IDFilter $parentFilter")->First();
-		if($reEnableFilter) self::enable_locale_filter();
+		if ($reEnableFilter) self::enable_locale_filter();
 
 		// By returning TRUE or FALSE, we overrule the base SiteTree->validateURLSegment() logic
 		return !$existingPage;

Braces +45 added lines, -15 removed lines

@@ -377,7 +377,9 @@ 
 	 */
 	protected function filtersOnLocale($query) {
 		foreach($query->getWhere() as $condition) {
-			if(preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) return true;
+			if(preg_match('/("|\'|`)Locale("|\'|`)/', $condition)) {
+				return true;
+			}
 		}
 	}
 
@@ -429,7 +431,9 @@ 
 	 // FIXME - NO TEST COVERAGE BUT REQUIRED
 	function augmentDatabase() {
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
-		if($this->owner->class != $baseDataClass) return;
+		if($this->owner->class != $baseDataClass) {
+			return;
+		}
 
 		$fields = array(
 			'OriginalID' => 'Int',
@@ -456,7 +460,9 @@ 
 	 */
 	public function requireDefaultRecords() {
 		// @todo This relies on the Locale attribute being on the base data class, and not any subclasses
-		if($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) return false;
+		if($this->owner->class != ClassInfo::baseDataClass($this->owner->class)) {
+			return false;
+		}
 
 		// Permissions: If a group doesn't have any specific TRANSLATE_<locale> edit rights,
 		// but has CMS_ACCESS_CMSMain (general CMS access), then assign TRANSLATE_ALL permissions as a default.
@@ -468,14 +474,20 @@ 
 			'CMS_ACCESS_LeftAndMain',
 			'ADMIN'
 		));
-		if($groups) foreach($groups as $group) {
+		if($groups) {
+			foreach($groups as $group) {
 			$codes = $group->Permissions()->column('Code');
+		}
 			$hasTranslationCode = false;
 			foreach($codes as $code) {
-				if(preg_match('/^TRANSLATE_/', $code)) $hasTranslationCode = true;
+				if(preg_match('/^TRANSLATE_/', $code)) {
+					$hasTranslationCode = true;
+				}
 			}
 			// Only add the code if no more restrictive code exists
-			if(!$hasTranslationCode) Permission::grant($group->ID, 'TRANSLATE_ALL');
+			if(!$hasTranslationCode) {
+				Permission::grant($group->ID, 'TRANSLATE_ALL');
+			}
 		}
 
 		// If the Translatable extension was added after the first records were already
@@ -485,7 +497,9 @@ 
 			'SELECT "ID" FROM "%s" WHERE "Locale" IS NULL OR "Locale" = \'\'',
 			ClassInfo::baseDataClass($this->owner->class)
 		))->column();
-		if(!$idsWithoutLocale) return;
+		if(!$idsWithoutLocale) {
+			return;
+		}
 
 
 
@@ -502,7 +516,9 @@ 
 	 * @param boolean $overwrite
 	 */
 	public function addTranslationGroup($originalID, $overwrite = false) {
-		if(!$this->owner->exists()) return false;
+		if(!$this->owner->exists()) {
+			return false;
+		}
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		$existingGroupID = $this->getTranslationGroup($originalID);
@@ -539,7 +555,9 @@ 
 	 * @return int Numeric ID of the translationgroup in the <classname>_translationgroup table
 	 */
 	public function getTranslationGroup() {
-		if(!$this->owner->exists()) return false;
+		if(!$this->owner->exists()) {
+			return false;
+		}
 
 		$baseDataClass = ClassInfo::baseDataClass($this->owner->class);
 		return DB::query(
@@ -646,8 +664,10 @@ 
 				$this->owner->ClassName = $changedFields['ClassName']['before'];
 				$translations = $this->owner->getTranslations();
 				$this->owner->ClassName = $changedFields['ClassName']['after'];
-				if($translations) foreach($translations as $translation) {
+				if($translations) {
+					foreach($translations as $translation) {
 					$translation->setClassName($this->owner->ClassName);
+				}
 					$translation = $translation->newClassInstance($translation->ClassName);
 					$translation->populateDefaults();
 					$translation->forceChange();
@@ -745,7 +765,9 @@ 
 	 * @return DataObjectSet
 	 */
 	function getTranslations($locale = null, $stage = null) {
-		if(!$this->owner->exists()) return new ArrayList();
+		if(!$this->owner->exists()) {
+			return new ArrayList();
+		}
 
 		// HACK need to disable language filtering in augmentSQL(),
 		// as we purposely want to get different language
@@ -770,14 +792,18 @@ 
 		$currentStage = Versioned::current_stage();
 		$joinOnClause = sprintf('"%s_translationgroups"."OriginalID" = "%s"."ID"', $baseDataClass, $baseDataClass);
 		if($this->owner->hasExtension("Versioned")) {
-			if($stage) Versioned::reading_stage($stage);
+			if($stage) {
+				Versioned::reading_stage($stage);
+			}
 			$translations = Versioned::get_by_stage(
 				$baseDataClass,
 				Versioned::current_stage(),
 				$filter,
 				null
 			)->leftJoin("{$baseDataClass}_translationgroups", $joinOnClause);
-			if($stage) Versioned::reading_stage($currentStage);
+			if($stage) {
+				Versioned::reading_stage($currentStage);
+			}
 		} else {
 			$class = $this->owner->class;
 			$translations = $baseDataClass::get()
@@ -861,7 +887,9 @@ 
 		self::set_current_locale($originalLocale);
 
 		if($original) {
-			if($translation = $original->getTranslation($locale)) return trim($translation->RelativeLink(true), '/');
+			if($translation = $original->getTranslation($locale)) {
+				return trim($translation->RelativeLink(true), '/');
+			}
 		}
 	}
 
@@ -916,7 +944,9 @@ 
 		$existingPage = SiteTree::get()
 			// disable get_one cache, as this otherwise may pick up results from when locale_filter was on
 			->where("\"URLSegment\" = '{$this->owner->URLSegment}' $IDFilter $parentFilter")->First();
-		if($reEnableFilter) self::enable_locale_filter();
+		if($reEnableFilter) {
+			self::enable_locale_filter();
+		}
 
 		// By returning TRUE or FALSE, we overrule the base SiteTree->validateURLSegment() logic
 		return !$existingPage;

Indentation +152 added lines, -152 removed lines

@@ -1,156 +1,156 @@ 
 <?php
 /**
- * The Translatable decorator allows your DataObjects to have versions in different languages,
- * defining which fields are can be translated. Translatable can be applied
- * to any {@link DataObject} subclass, but is mostly used with {@link SiteTree}.
- * Translatable is compatible with the {@link Versioned} extension.
- * To avoid cluttering up the database-schema of the 99% of sites without multiple languages,
- * the translation-feature is disabled by default.
- *
- * Locales (e.g. 'en_US') are used in Translatable for identifying a record by language,
- * see section "Locales and Language Tags".
- *
- * <h2>Configuration</h2>
- *
- * The extension is automatically enabled for SiteTree and SiteConfig records,
- * if they can be found. Add the following to your config.yml in order to
- * register a custom class:
- *
- * <code>
- * MyClass:
- *   extensions:
- *     Translatable
- * </code>
- *
- * Make sure to rebuild the database through /dev/build after enabling translatable.
- * Use the correct {@link set_default_locale()} before building the database
- * for the first time, as this locale will be written on all new records.
- *
- * <h3>"Default" locales</h3>
- *
- * Important: If the "default language" of your site is not US-English (en_US),
- * please ensure to set the appropriate default language for
- * your content before building the database with Translatable enabled:
- * <code>
- * Translatable::set_default_locale(<locale>); // e.g. 'de_DE' or 'fr_FR'
- * </code>
- *
- * For the Translatable class, a "locale" consists of a language code plus a region
- * code separated by an underscore,
- * for example "de_AT" for German language ("de") in the region Austria ("AT").
- * See http://www.w3.org/International/articles/language-tags/ for a detailed description.
- *
- * <h2>Usage</h2>
- *
- * Getting a translation for an existing instance:
- * <code>
- * $translatedObj = Translatable::get_one_by_locale('MyObject', 'de_DE');
- * </code>
- *
- * Getting a translation for an existing instance:
- * <code>
- * $obj = DataObject::get_by_id('MyObject', 99); // original language
- * $translatedObj = $obj->getTranslation('de_DE');
- * </code>
- *
- * Getting translations through {@link Translatable::set_current_locale()}.
- * This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
- * <code>
- * $origLocale = Translatable::get_current_locale();
- * Translatable::set_current_locale('de_DE');
- * $obj = Versioned::get_one_by_stage('MyObject', "ID = 99");
- * Translatable::set_current_locale($origLocale);
- * </code>
- *
- * Creating a translation:
- * <code>
- * $obj = new MyObject();
- * $translatedObj = $obj->createTranslation('de_DE');
- * </code>
- *
- * <h2>Usage for SiteTree</h2>
- *
- * Translatable can be used for subclasses of {@link SiteTree},
- * it is automatically configured if this class is foun.
- *
- * If a child page translation is requested without the parent
- * page already having a translation in this language, the extension
- * will recursively create translations up the tree.
- * Caution: The "URLSegment" property is enforced to be unique across
- * languages by auto-appending the language code at the end.
- * You'll need to ensure that the appropriate "reading language" is set
- * before showing links to other pages on a website through $_GET['locale'].
- * Pages in different languages can have different publication states
- * through the {@link Versioned} extension.
- *
- * Note: You can't get Children() for a parent page in a different language
- * through set_current_locale(). Get the translated parent first.
- *
- * <code>
- * // wrong
- * Translatable::set_current_locale('de_DE');
- * $englishParent->Children();
- * // right
- * $germanParent = $englishParent->getTranslation('de_DE');
- * $germanParent->Children();
- * </code>
- *
- * <h2>Translation groups</h2>
- *
- * Each translation can have one or more related pages in other languages.
- * This relation is optional, meaning you can
- * create translations which have no representation in the "default language".
- * This means you can have a french translation with a german original,
- * without either of them having a representation
- * in the default english language tree.
- * Caution: There is no versioning for translation groups,
- * meaning associating an object with a group will affect both stage and live records.
- *
- * SiteTree database table (abbreviated)
- * ^ ID ^ URLSegment ^ Title ^ Locale ^
- * | 1 | about-us | About us | en_US |
- * | 2 | ueber-uns | Über uns | de_DE |
- * | 3 | contact | Contact | en_US |
- *
- * SiteTree_translationgroups database table
- * ^ TranslationGroupID ^ OriginalID ^
- * | 99 | 1 |
- * | 99 | 2 |
- * | 199 | 3 |
- *
- * <h2>Character Sets</h2>
- *
- * Caution: Does not apply any character-set conversion, it is assumed that all content
- * is stored and represented in UTF-8 (Unicode). Please make sure your database and
- * HTML-templates adjust to this.
- *
- * <h2>Permissions</h2>
- *
- * Authors without administrative access need special permissions to edit locales other than
- * the default locale.
- *
- * - TRANSLATE_ALL: Translate into all locales
- * - Translate_<locale>: Translate a specific locale. Only available for all locales set in
- *   `Translatable::set_allowed_locales()`.
- *
- * Note: If user-specific view permissions are required, please overload `SiteTree->canView()`.
- *
- * <h2>Uninstalling/Disabling</h2>
- *
- * Disabling Translatable after creating translations will lead to all
- * pages being shown in the default sitetree regardless of their language.
- * It is advised to start with a new database after uninstalling Translatable,
- * or manually filter out translated objects through their "Locale" property
- * in the database.
- *
- * @see http://doc.silverstripe.org/doku.php?id=multilingualcontent
- *
- * @author Ingo Schommer <ingo (at) silverstripe (dot) com>
- * @author Michael Gall <michael (at) wakeless (dot) net>
- * @author Bernat Foj Capell <bernat@silverstripe.com>
- *
- * @package translatable
- */
+	 * The Translatable decorator allows your DataObjects to have versions in different languages,
+	 * defining which fields are can be translated. Translatable can be applied
+	 * to any {@link DataObject} subclass, but is mostly used with {@link SiteTree}.
+	 * Translatable is compatible with the {@link Versioned} extension.
+	 * To avoid cluttering up the database-schema of the 99% of sites without multiple languages,
+	 * the translation-feature is disabled by default.
+	 *
+	 * Locales (e.g. 'en_US') are used in Translatable for identifying a record by language,
+	 * see section "Locales and Language Tags".
+	 *
+	 * <h2>Configuration</h2>
+	 *
+	 * The extension is automatically enabled for SiteTree and SiteConfig records,
+	 * if they can be found. Add the following to your config.yml in order to
+	 * register a custom class:
+	 *
+	 * <code>
+	 * MyClass:
+	 *   extensions:
+	 *     Translatable
+	 * </code>
+	 *
+	 * Make sure to rebuild the database through /dev/build after enabling translatable.
+	 * Use the correct {@link set_default_locale()} before building the database
+	 * for the first time, as this locale will be written on all new records.
+	 *
+	 * <h3>"Default" locales</h3>
+	 *
+	 * Important: If the "default language" of your site is not US-English (en_US),
+	 * please ensure to set the appropriate default language for
+	 * your content before building the database with Translatable enabled:
+	 * <code>
+	 * Translatable::set_default_locale(<locale>); // e.g. 'de_DE' or 'fr_FR'
+	 * </code>
+	 *
+	 * For the Translatable class, a "locale" consists of a language code plus a region
+	 * code separated by an underscore,
+	 * for example "de_AT" for German language ("de") in the region Austria ("AT").
+	 * See http://www.w3.org/International/articles/language-tags/ for a detailed description.
+	 *
+	 * <h2>Usage</h2>
+	 *
+	 * Getting a translation for an existing instance:
+	 * <code>
+	 * $translatedObj = Translatable::get_one_by_locale('MyObject', 'de_DE');
+	 * </code>
+	 *
+	 * Getting a translation for an existing instance:
+	 * <code>
+	 * $obj = DataObject::get_by_id('MyObject', 99); // original language
+	 * $translatedObj = $obj->getTranslation('de_DE');
+	 * </code>
+	 *
+	 * Getting translations through {@link Translatable::set_current_locale()}.
+	 * This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
+	 * <code>
+	 * $origLocale = Translatable::get_current_locale();
+	 * Translatable::set_current_locale('de_DE');
+	 * $obj = Versioned::get_one_by_stage('MyObject', "ID = 99");
+	 * Translatable::set_current_locale($origLocale);
+	 * </code>
+	 *
+	 * Creating a translation:
+	 * <code>
+	 * $obj = new MyObject();
+	 * $translatedObj = $obj->createTranslation('de_DE');
+	 * </code>
+	 *
+	 * <h2>Usage for SiteTree</h2>
+	 *
+	 * Translatable can be used for subclasses of {@link SiteTree},
+	 * it is automatically configured if this class is foun.
+	 *
+	 * If a child page translation is requested without the parent
+	 * page already having a translation in this language, the extension
+	 * will recursively create translations up the tree.
+	 * Caution: The "URLSegment" property is enforced to be unique across
+	 * languages by auto-appending the language code at the end.
+	 * You'll need to ensure that the appropriate "reading language" is set
+	 * before showing links to other pages on a website through $_GET['locale'].
+	 * Pages in different languages can have different publication states
+	 * through the {@link Versioned} extension.
+	 *
+	 * Note: You can't get Children() for a parent page in a different language
+	 * through set_current_locale(). Get the translated parent first.
+	 *
+	 * <code>
+	 * // wrong
+	 * Translatable::set_current_locale('de_DE');
+	 * $englishParent->Children();
+	 * // right
+	 * $germanParent = $englishParent->getTranslation('de_DE');
+	 * $germanParent->Children();
+	 * </code>
+	 *
+	 * <h2>Translation groups</h2>
+	 *
+	 * Each translation can have one or more related pages in other languages.
+	 * This relation is optional, meaning you can
+	 * create translations which have no representation in the "default language".
+	 * This means you can have a french translation with a german original,
+	 * without either of them having a representation
+	 * in the default english language tree.
+	 * Caution: There is no versioning for translation groups,
+	 * meaning associating an object with a group will affect both stage and live records.
+	 *
+	 * SiteTree database table (abbreviated)
+	 * ^ ID ^ URLSegment ^ Title ^ Locale ^
+	 * | 1 | about-us | About us | en_US |
+	 * | 2 | ueber-uns | Über uns | de_DE |
+	 * | 3 | contact | Contact | en_US |
+	 *
+	 * SiteTree_translationgroups database table
+	 * ^ TranslationGroupID ^ OriginalID ^
+	 * | 99 | 1 |
+	 * | 99 | 2 |
+	 * | 199 | 3 |
+	 *
+	 * <h2>Character Sets</h2>
+	 *
+	 * Caution: Does not apply any character-set conversion, it is assumed that all content
+	 * is stored and represented in UTF-8 (Unicode). Please make sure your database and
+	 * HTML-templates adjust to this.
+	 *
+	 * <h2>Permissions</h2>
+	 *
+	 * Authors without administrative access need special permissions to edit locales other than
+	 * the default locale.
+	 *
+	 * - TRANSLATE_ALL: Translate into all locales
+	 * - Translate_<locale>: Translate a specific locale. Only available for all locales set in
+	 *   `Translatable::set_allowed_locales()`.
+	 *
+	 * Note: If user-specific view permissions are required, please overload `SiteTree->canView()`.
+	 *
+	 * <h2>Uninstalling/Disabling</h2>
+	 *
+	 * Disabling Translatable after creating translations will lead to all
+	 * pages being shown in the default sitetree regardless of their language.
+	 * It is advised to start with a new database after uninstalling Translatable,
+	 * or manually filter out translated objects through their "Locale" property
+	 * in the database.
+	 *
+	 * @see http://doc.silverstripe.org/doku.php?id=multilingualcontent
+	 *
+	 * @author Ingo Schommer <ingo (at) silverstripe (dot) com>
+	 * @author Michael Gall <michael (at) wakeless (dot) net>
+	 * @author Bernat Foj Capell <bernat@silverstripe.com>
+	 *
+	 * @package translatable
+	 */
 class Translatable extends DataExtension implements TestOnly {
 
 	const QUERY_LOCALE_FILTER_ENABLED = 'Translatable.LocaleFilterEnabled';
@@ -892,7 +892,7 @@ 
 	 * to Translatable
 	 *
 	 * @return bool
-     */
+	 */
 	public function augmentValidURLSegment() {
 		$reEnableFilter = false;
 		if(!Config::inst()->get('Translatable', 'enforce_global_unique_urls')) {

tests/QueryGeneratorTest.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
 	}
 
 
+	/**
+	 * @param string $q
+	 */
 	private function getDefaultSuggest($q) {
 		return array(
 				'query-phrase-suggestions' => array(

Spacing +27 added lines, -27 removed lines

@@ -122,7 +122,7 @@ 
 
 		$qg->setShowResultsForEmptyQuery(false);
 		$qs = array('multi_match' => array(
-			'fields' => array('Title','Title.*','Description','Description.*'),
+			'fields' => array('Title', 'Title.*', 'Description', 'Description.*'),
 			'type' => 'most_fields',
 			'query' => 'New Zealand',
 			'lenient' => true
@@ -158,7 +158,7 @@ 
 		$qg->setShowResultsForEmptyQuery(false);
 		$qs = array(
 			'multi_match' => array(
-				'fields' => array('Title','Title.*','Description','Description.*'),
+				'fields' => array('Title', 'Title.*', 'Description', 'Description.*'),
 				'type' => 'most_fields',
 				'query' => '',
 				'lenient' => true
@@ -369,8 +369,8 @@ 
 				'filtered' => array(
 					'filter' =>
 					array('and' => array(
-						0 => array( 'term' =>  array('ISO' => 400)),
-						1 => array( 'range' => array(
+						0 => array('term' =>  array('ISO' => 400)),
+						1 => array('range' => array(
 							'AspectRatio' => array(
 								'gte' => '0.9',
 								'lt' => '1.2'
@@ -413,14 +413,14 @@ 
 			'query' => array(
 				'filtered' => array('filter' =>
 					array('and' => array(
-						0 => array( 'term' =>  array('ISO' => 400)),
-						1 => array( 'range' => array(
+						0 => array('term' =>  array('ISO' => 400)),
+						1 => array('range' => array(
 							'AspectRatio' => array(
 								'gte' => '0.9',
 								'lt' => '1.2'
 							)
 						)),
-						2 => array( 'term' =>  array('Aperture' => 5.6)),
+						2 => array('term' =>  array('Aperture' => 5.6)),
 					)
 				))
 			),
@@ -472,7 +472,7 @@ 
 		$expected['query']['filtered']['query']['multi_match'] = array(
 			'query' => 'New Zealand',
 			'lenient' => true,
-			'fields' => array('Title^2', 'Title.*^2','Content', 'Content.*'),
+			'fields' => array('Title^2', 'Title.*^2', 'Content', 'Content.*'),
 			'type' => 'most_fields'
 		);
 
@@ -503,8 +503,8 @@ 
 				'filtered' => array(
 					'filter' =>
 					array('and' => array(
-						0 => array( 'term' =>  array('ISO' => 400)),
-						1 => array( 'range' => array(
+						0 => array('term' =>  array('ISO' => 400)),
+						1 => array('range' => array(
 							'AspectRatio' => array(
 								'gte' => '0.9',
 								'lt' => '1.2'
@@ -525,7 +525,7 @@ 
 		$expected['query']['filtered']['query']['multi_match'] = array(
 			'query' => 'New Zealand',
 			'lenient' => true,
-			'fields' => array('Title^2', 'Title.*^2','Content', 'Content.*'),
+			'fields' => array('Title^2', 'Title.*^2', 'Content', 'Content.*'),
 			'type' => 'most_fields'
 		);
 		$expected['suggest'] = $this->getDefaultSuggest('New Zealand');
@@ -553,14 +553,14 @@ 
 			'query' => array(
 				'filtered' => array('filter' =>
 					array('and' => array(
-						0 => array( 'term' =>  array('ISO' => 400)),
-						1 => array( 'range' => array(
+						0 => array('term' =>  array('ISO' => 400)),
+						1 => array('range' => array(
 							'AspectRatio' => array(
 								'gte' => '0.9',
 								'lt' => '1.2'
 							)
 						)),
-						2 => array( 'term' =>  array('Aperture' => 5.6)),
+						2 => array('term' =>  array('Aperture' => 5.6)),
 					)
 				))
 			),
@@ -575,7 +575,7 @@ 
 		$expected['query']['filtered']['query']['multi_match'] = array(
 			'query' => 'New Zealand',
 			'lenient' => true,
-			'fields' => array('Title^2', 'Title.*^2','Content', 'Content.*'),
+			'fields' => array('Title^2', 'Title.*^2', 'Content', 'Content.*'),
 			'type' => 'most_fields'
 		);
 		$expected['suggest'] = $this->getDefaultSuggest('New Zealand');
@@ -590,7 +590,7 @@ 
 		$qg = new QueryGenerator();
 		$qg->setClasses('FlickrPhotoTO');
 		$fields = array('Title' => 1, 'Description' => 1);
-		$expected = array('Title', 'Title.*','Description', 'Description.*');
+		$expected = array('Title', 'Title.*', 'Description', 'Description.*');
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 	}
 
@@ -599,7 +599,7 @@ 
 		$qg = new QueryGenerator();
 		$qg->setClasses('FlickrPhotoTO');
 		$fields = array('Title' => 2, 'Description' => 1);
-		$expected = array('Title^2', 'Title.*^2','Description', 'Description.*');
+		$expected = array('Title^2', 'Title.*^2', 'Description', 'Description.*');
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 	}
 
@@ -631,10 +631,10 @@ 
 		$qg = new QueryGenerator();
 		$qg->setClasses('FlickrPhotoTO,Page');
 		$fields = array('Title' => 2, 'Description' => 1);
-		$expected = array('Title^2', 'Title.*^2','Description', 'Description.*');
+		$expected = array('Title^2', 'Title.*^2', 'Description', 'Description.*');
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 
-		$qg->setClasses(array('FlickrPhotoTO','Page'));
+		$qg->setClasses(array('FlickrPhotoTO', 'Page'));
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 
 	}
@@ -648,7 +648,7 @@ 
 		$qg = new QueryGenerator();
 		$qg->setClasses('FlickrPhotoTO,Page');
 		$fields = array('Title' => 2, 'Description' => 1);
-		$expected = array('Title^2', 'Title.*^2','Description', 'Description.*');
+		$expected = array('Title^2', 'Title.*^2', 'Description', 'Description.*');
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 
 		//Execute a 2nd time
@@ -667,11 +667,11 @@ 
 		$qg = new QueryGenerator();
 		$qg->setClasses(null); // select all of site tree classes
 		$fields = array('Title' => 2, 'Content' => 1);
-		$expected = array('Title^2', 'Title.*^2','Content', 'Content.*');
+		$expected = array('Title^2', 'Title.*^2', 'Content', 'Content.*');
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 
 		echo "--------------------\n";
-		$qg->setClasses(array('FlickrPhotoTO','Page'));
+		$qg->setClasses(array('FlickrPhotoTO', 'Page'));
 		$this->assertEquals($expected, $qg->convertWeightedFieldsForElastica($fields));
 
 	}
@@ -720,21 +720,21 @@ 
 				'order' => array('_term' => 'asc')
 			)
 		);
-		$result['ShutterSpeed'] =  array(
+		$result['ShutterSpeed'] = array(
 			'terms' => array(
 				'field' => 'ShutterSpeed',
 				'size' => 0,
 				'order' => array('_term' => 'asc')
 			)
 		);
-		$result['FocalLength35mm'] =  array(
+		$result['FocalLength35mm'] = array(
 			'terms' => array(
 				'field' => 'FocalLength35mm',
 				'size' => 0,
 				'order' => array('_term' => 'asc')
 			)
 		);
-		$result['ISO'] =  array(
+		$result['ISO'] = array(
 			'terms' => array(
 				'field' => 'ISO',
 				'size' => 0,
@@ -749,7 +749,7 @@ 
 		$ranges[3] = array('from' => '1.2', 'to' => '1.79', 'key' => 'Vertical');
 		$ranges[4] = array('from' => '1.79', 'to' => '10000000', 'key' => 'Tallest');
 
-		$result['Aspect'] =  array(
+		$result['Aspect'] = array(
 			'range' => array(
 				'field' => 'AspectRatio',
 				'ranges' => $ranges
@@ -769,7 +769,7 @@ 
 
 	public function testToQuotedCSVFromArray() {
 		$expected = "'Bangkok','Nonthaburi','Saraburi','Chiang Mai'";
-		$items = array('Bangkok','Nonthaburi','Saraburi','Chiang Mai');
+		$items = array('Bangkok', 'Nonthaburi', 'Saraburi', 'Chiang Mai');
 		$quoted = QueryGenerator::convertToQuotedCSV($items);
 		$this->assertEquals($expected, $quoted);
 	}

tests/SearchAndIndexingTest.php

Doc Comments +3 added lines

@@ -479,6 +479,9 @@
 	}
 
 
+	/**
+	 * @param string $query
+	 */
 	private function getResultsFor($query, $pageLength = 10, $fields = array('Title' => 1, 'Description' => 1)) {
 		$es = new ElasticSearcher();
 		$es->setStart(0);

Indentation +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 
 	public function testEach() {
 		$callback = function($fp) {
-		    $this->assertTrue(true, 'Callback reached');
+			$this->assertTrue(true, 'Callback reached');
 		};
 		$resultList = $this->getResultsFor('New Zealand',10);
 		$resultList->each($callback);

Spacing +37 added lines, -37 removed lines

@@ -43,16 +43,16 @@ 
 		$stopwords = "a,the,then,this";
 		$englishIndex = new EnglishIndexSettings();
 		$englishIndex->setStopwords($stopwords);
-		$expected = array('a','the','then','this');
+		$expected = array('a', 'the', 'then', 'this');
 		$this->assertEquals($expected, $englishIndex->getStopwords());
 	}
 
 
 	public function testSetStopwordsConfigurationArray() {
-		$stopwords = array('a','the','then','this');
+		$stopwords = array('a', 'the', 'then', 'this');
 		$englishIndex = new EnglishIndexSettings();
 		$englishIndex->setStopwords($stopwords);
-		$expected = array('a','the','then','this');
+		$expected = array('a', 'the', 'then', 'this');
 		$this->assertEquals($expected, $englishIndex->getStopwords());
 	}
 
@@ -92,9 +92,9 @@ 
 			'ISO' => 1
 		);
 
-		$expected = array('that','into','a','an','and','are','as','at','be','but','by','for','if',
-			'in','into','is','it','of','on','or','such','that','the','their','then','there','these',
-			'they','this','to','was','will','with');
+		$expected = array('that', 'into', 'a', 'an', 'and', 'are', 'as', 'at', 'be', 'but', 'by', 'for', 'if',
+			'in', 'into', 'is', 'it', 'of', 'on', 'or', 'such', 'that', 'the', 'their', 'then', 'there', 'these',
+			'they', 'this', 'to', 'was', 'will', 'with');
 		$this->assertEquals($expected, $stopwords);
 	}
 
@@ -106,7 +106,7 @@ 
 
 
 	public function testResultListGetMap() {
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		//default is ID -> Title, useful for dropdowns
 		$mapping = $resultList->map();
 		$ctr = 0;
@@ -119,7 +119,7 @@ 
 
 
 	public function testResultListColumn() {
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		$ids = $resultList->column();
 
 		$expected = array();
@@ -127,14 +127,14 @@ 
 			array_push($expected, $item->ID);
 		}
 
-		$this->assertEquals($expected,$ids);
+		$this->assertEquals($expected, $ids);
 
 		$expected = array();
 		foreach ($resultList as $item) {
 			array_push($expected, $item->Title);
 		}
 		$titles = $resultList->column('Title');
-		$this->assertEquals($expected,$titles);
+		$this->assertEquals($expected, $titles);
 	}
 
 
@@ -142,7 +142,7 @@ 
 		$callback = function($fp) {
 		    $this->assertTrue(true, 'Callback reached');
 		};
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		$resultList->each($callback);
 	}
 
@@ -152,22 +152,22 @@ 
 	that all of the fixtures should have 'New Zealand' in them.  Test page length from 1 to 100
 	 */
 	public function testResultListPageLength() {
-		for ($i=1; $i <= 100 ; $i++) {
-			$resultList = $this->getResultsFor('New Zealand',$i);
+		for ($i = 1; $i <= 100; $i++) {
+			$resultList = $this->getResultsFor('New Zealand', $i);
 			$this->assertEquals($i, $resultList->count());
 		}
 	}
 
 
 	public function testResultListIndex() {
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		$index = $resultList->getService()->getIndex();
 		$this->assertEquals('elastica_ss_module_test_en_us', $index->getName());
 	}
 
 
 	public function testResultListGetQuery() {
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		$query = $resultList->getQuery()->toArray();
 
 		$expected = array();
@@ -192,7 +192,7 @@ 
 	Check that the time for the search was more than zero
 	 */
 	public function testResultListGetTotalTime() {
-		$resultList = $this->getResultsFor('New Zealand',10);
+		$resultList = $this->getResultsFor('New Zealand', 10);
 		$time = $resultList->getTotalTime();
 		$this->assertGreaterThan(0, $time);
 	}
@@ -202,12 +202,12 @@ 
 	Test the result list iterator function
 	 */
 	public function testResultListGetIterator() {
-		$resultList = $this->getResultsFor('New Zealand',100);
+		$resultList = $this->getResultsFor('New Zealand', 100);
 		$ctr = 0;
 		foreach ($resultList->getIterator() as $result) {
 			$ctr++;
 		}
-		$this->assertEquals(100,$ctr);
+		$this->assertEquals(100, $ctr);
 	}
 
 
@@ -215,15 +215,15 @@ 
 	Check some basic properties of the array returned for a result
 	 */
 	public function testToArrayFunction() {
-		$resultList = $this->getResultsFor('New Zealand',1);
+		$resultList = $this->getResultsFor('New Zealand', 1);
 		$expected = array();
 		$result = $resultList->toArray();
 
-		$this->assertEquals(1,sizeof($result));
+		$this->assertEquals(1, sizeof($result));
 		$fp = $result[0];
 		$this->assertEquals('FlickrPhotoTO', $fp->ClassName);
 		$this->assertEquals(2147483647, $fp->FlickrID);
-		$this->assertTrue(preg_match('/New Zealand/',$fp->Title) == 1);
+		$this->assertTrue(preg_match('/New Zealand/', $fp->Title) == 1);
 	}
 
 
@@ -231,21 +231,21 @@ 
 	Check some basic properties of the array returned for a result
 	 */
 	public function testToNestedArrayFunction() {
-		$resultList = $this->getResultsFor('New Zealand',4);
+		$resultList = $this->getResultsFor('New Zealand', 4);
 		$expected = array();
 		$result = $resultList->toNestedArray();
 
-		$this->assertEquals(4,sizeof($result));
+		$this->assertEquals(4, sizeof($result));
 		$fp = $result[0];
 		$this->assertEquals('FlickrPhotoTO', $fp['ClassName']);
 		$this->assertEquals(2147483647, $fp['FlickrID']);
-		$this->assertTrue(preg_match('/New Zealand/',$fp['Title']) == 1);
+		$this->assertTrue(preg_match('/New Zealand/', $fp['Title']) == 1);
 	}
 
 
 	public function testResultListOffsetExistsNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$resultList->offsetExists(10);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
@@ -256,7 +256,7 @@ 
 
 	public function testResultListOffsetGetNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$resultList->offsetGet(10);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
@@ -267,8 +267,8 @@ 
 
 	public function testResultListOffsetSetNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
-			$resultList->offsetSet(10,null);
+			$resultList = $this->getResultsFor('New Zealand', 10);
+			$resultList->offsetSet(10, null);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
 			$this->assertEquals('Not implemented', $e->getMessage());
@@ -278,7 +278,7 @@ 
 
 	public function testResultListOffsetUnsetNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$resultList->offsetUnset(10);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
@@ -289,7 +289,7 @@ 
 
 	public function testResultListAddNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$fp = new FlickrPhotoTO();
 			$resultList->add($fp);
 			$this->assertFalse(true, "This line should not have been reached");
@@ -301,7 +301,7 @@ 
 
 	public function testResultListRemoveNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$fp = new FlickrPhotoTO();
 			$resultList->remove($fp);
 			$this->assertFalse(true, "This line should not have been reached");
@@ -313,9 +313,9 @@ 
 
 	public function testResultListFindNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$fp = new FlickrPhotoTO();
-			$resultList->find(4,$fp);
+			$resultList->find(4, $fp);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
 			$this->assertEquals('Not implemented', $e->getMessage());
@@ -351,9 +351,9 @@ 
 
 	public function testResultListFirstNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$fp = new FlickrPhotoTO();
-			$resultList->first(4,$fp);
+			$resultList->first(4, $fp);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
 			$this->assertEquals('Not implemented', $e->getMessage());
@@ -363,9 +363,9 @@ 
 
 	public function testResultListLastNotImplemented() {
 		try {
-			$resultList = $this->getResultsFor('New Zealand',10);
+			$resultList = $this->getResultsFor('New Zealand', 10);
 			$fp = new FlickrPhotoTO();
-			$resultList->last(4,$fp);
+			$resultList->last(4, $fp);
 			$this->assertFalse(true, "This line should not have been reached");
 		} catch (Exception $e) {
 			$this->assertEquals('Not implemented', $e->getMessage());

tests/TranslatableUnitTest.php

Doc Comments +3 added lines

@@ -233,6 +233,9 @@
 
 
 
+	/**
+	 * @param PaginatedList $paginated
+	 */
 	private function makeCode($paginated) {
 		$results = $paginated->getList()->toArray();
 		$ctr = 0;

Spacing +10 added lines, -10 removed lines

@@ -20,7 +20,7 @@ 
 		$form = new \ElasticSearchForm(new \Controller(), 'TestForm');
 		$fields = $form->Fields();
 		$result = array();
-		foreach($fields as $field) {
+		foreach ($fields as $field) {
 			echo $field->getName();
 			$result[$field->getName()] = $field->Value();
 		}
@@ -51,12 +51,12 @@ 
 				$wordFound = false;
 				$lcquery = explode(' ', strtolower($query));
 				foreach ($lcquery as $part) {
-					$bracketed = '<strong class="hl">'.$part.'</strong>';
+					$bracketed = '<strong class="hl">' . $part . '</strong>';
 					if (strpos($snippet, $bracketed) > 0) {
 						$wordFound = true;
 					}
 				}
-				$this->assertTrue($wordFound,'Highlight should have been found');
+				$this->assertTrue($wordFound, 'Highlight should have been found');
 			}
 		}
 	}
@@ -89,7 +89,7 @@ 
 		$es->setLocale($locale);
 		$es->setClasses('FlickrPhotoTO');
 
-		$fields = array('Description.standard' => 1,'Title.standard' => 1);
+		$fields = array('Description.standard' => 1, 'Title.standard' => 1);
 		$results = $es->moreLikeThis($fp, $fields, true);
 
 		echo "RESULTS:\n";
@@ -110,7 +110,7 @@ 
 		$expected = array('texas');
 		$this->assertEquals($expected, $terms['Title.standard']);
 
-		$expected = array('new', 'see','photographs', 'information','resolution', 'company', 'view',
+		$expected = array('new', 'see', 'photographs', 'information', 'resolution', 'company', 'view',
 			'high', 'collection', 'pacific', 'orleans', 'degolyer', 'southern', 'everett',
 			'railroad', 'texas');
 
@@ -144,7 +144,7 @@ 
 		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
 		$paginated = $es->moreLikeThis($fp, $fields, true);
 		foreach ($paginated->getList() as $result) {
-			echo $result->ID. ' : '.$result->Title."\n";
+			echo $result->ID . ' : ' . $result->Title . "\n";
 		}
 		$this->assertEquals(32, $paginated->getTotalItems());
 		$results = $paginated->getList()->toArray();
@@ -179,7 +179,7 @@ 
 		//Check that the number of indexing requests has increased by 2
 		$deltaReqs = $this->service->getIndexingRequestCtr() - $reqs;
 		//One call is made for each of Page and FlickrPhotoTO
-		$this->assertEquals(2,$deltaReqs);
+		$this->assertEquals(2, $deltaReqs);
 
 		// default installed pages plus 100 FlickrPhotoTOs
 		$this->checkNumberOfIndexedDocuments(103);
@@ -195,7 +195,7 @@ 
 		$fields = array('Title.standard' => 1, 'Description.standard' => 1);
 		$paginated = $es->moreLikeThis($fp, $fields, true);
 		foreach ($paginated->getList() as $result) {
-			echo $result->ID. ' : '.$result->Title."\n";
+			echo $result->ID . ' : ' . $result->Title . "\n";
 		}
 		$this->assertEquals(14, $paginated->getTotalItems());
 		$results = $paginated->getList()->toArray();
@@ -236,9 +236,9 @@ 
 	private function makeCode($paginated) {
 		$results = $paginated->getList()->toArray();
 		$ctr = 0;
-		echo '$result = $paginated->getList()->toArray();'."\n";
+		echo '$result = $paginated->getList()->toArray();' . "\n";
 		foreach ($results as $result) {
-			echo '$this->assertEquals("'.$result->Title.'", $results['.$ctr.']->Title);'."\n";
+			echo '$this->assertEquals("' . $result->Title . '", $results[' . $ctr . ']->Title);' . "\n";
 			$ctr++;
 		}
 	}

code/SearchableClass.php

Indentation +12 added lines, -12 removed lines

@@ -29,20 +29,20 @@ 
 		$config->removeComponent($config->getComponentByType('GridFieldDeleteAction'));
 
 		$config->getComponentByType('GridFieldDataColumns')->setDisplayFields(array(
-            'Name' => 'Name',
-            'Weight' => 'Weighting',
-            'Searchable' => 'Search this field?'
-        ));
+			'Name' => 'Name',
+			'Weight' => 'Weighting',
+			'Searchable' => 'Search this field?'
+		));
 
 
-        $gridField = new GridField(
-            'SearchableField', // Field name
-            'Field Name', // Field title
-            SearchableField::get()->filter('SearchableClassID', $this->ID)->sort('Name'),
-            $config
-        );
+		$gridField = new GridField(
+			'SearchableField', // Field name
+			'Field Name', // Field title
+			SearchableField::get()->filter('SearchableClassID', $this->ID)->sort('Name'),
+			$config
+		);
 
-        $fields->addFieldToTab('Root.Main', $gridField);
+		$fields->addFieldToTab('Root.Main', $gridField);
 
 		/*
 	    $fields = new FieldList();
@@ -50,7 +50,7 @@ 
 
 
         */
-	    return $fields;
+		return $fields;
 	}
 
 

Spacing +3 added lines, -3 removed lines

@@ -15,10 +15,10 @@
 
 		$fields = new FieldList();
 
-		$fields->push( new TabSet( "Root", $mainTab = new Tab( "Main" ) ) );
-		$mainTab->setTitle( _t( 'SiteTree.TABMAIN', "Main" ) );
+		$fields->push(new TabSet("Root", $mainTab = new Tab("Main")));
+		$mainTab->setTitle(_t('SiteTree.TABMAIN', "Main"));
 
-		$fields->addFieldToTab( 'Root.Main',  $nf = new TextField( 'Name', 'Name') );
+		$fields->addFieldToTab('Root.Main', $nf = new TextField('Name', 'Name'));
 		$nf->setReadOnly(true);
 		$nf->setDisabled(true);
 

code/SearchableField.php

Spacing +4 added lines, -4 removed lines

@@ -24,10 +24,10 @@
 
 	function getCMSFields() {
 		$fields = new FieldList();
-		$fields->push( new TabSet( "Root", $mainTab = new Tab( "Main" ) ) );
-		$mainTab->setTitle( _t( 'SiteTree.TABMAIN', "Main" ) );
-		$fields->addFieldToTab( 'Root.Main',  $cf = new TextField( 'ClazzName', 'Class sourced from') );
-		$fields->addFieldToTab( 'Root.Main',  $nf = new TextField( 'Name', 'Name') );
+		$fields->push(new TabSet("Root", $mainTab = new Tab("Main")));
+		$mainTab->setTitle(_t('SiteTree.TABMAIN', "Main"));
+		$fields->addFieldToTab('Root.Main', $cf = new TextField('ClazzName', 'Class sourced from'));
+		$fields->addFieldToTab('Root.Main', $nf = new TextField('Name', 'Name'));
 		$cf->setDisabled(true);
 		$nf->setDisabled(true);
 		$cf->setReadOnly(true);

code/ElasticaAutoCompleteController.php

Spacing +2 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
 		// Makes most sense to only provide one field here, e.g. Title, Name
 		$field = $this->request->getVar('field');
 
-		error_log('QUERY:'.$query);
+		error_log('QUERY:' . $query);
 
 		// start, and page length, i.e. pagination
 		$es->setPageLength(10);
@@ -32,7 +32,7 @@ 
 			$es->addFilter('InSiteTree', true);
 		}
 
-		$resultList = $es->autocomplete_search($query,$field);
+		$resultList = $es->autocomplete_search($query, $field);
 		$result = array();
 		$result['Query'] = $query;
 		$suggestions = array();

code/ElasticaUtil.php

Indentation +38 added lines, -38 removed lines

@@ -92,26 +92,26 @@ 
 					//Need to check capitalisation of terms suggested that are different
 
 					$chr = mb_substr ($possiblyUppercase, 0, 1, "UTF-8");
-    				if (mb_strtolower($chr, "UTF-8") != $chr) {
-    					$upperLowercaseWord = $lowercaseWord;
-    					$upperLowercaseWord[0] = $chr;
+					if (mb_strtolower($chr, "UTF-8") != $chr) {
+						$upperLowercaseWord = $lowercaseWord;
+						$upperLowercaseWord[0] = $chr;
 
-    					//$possiblyUppercaseHighlighted = str_replace($lowercaseWord, $possiblyUppercase, $possiblyUppercaseHighlighted);
-    					$withHighlights = str_replace($lowercaseWord, $upperLowercaseWord, $possiblyUppercaseHighlighted);
+						//$possiblyUppercaseHighlighted = str_replace($lowercaseWord, $possiblyUppercase, $possiblyUppercaseHighlighted);
+						$withHighlights = str_replace($lowercaseWord, $upperLowercaseWord, $possiblyUppercaseHighlighted);
 
-    					$lowercaseWord[0] = $chr;
+						$lowercaseWord[0] = $chr;
 
-    					//str_replace(search, replace, subject)
+						//str_replace(search, replace, subject)
 
-    					array_push($plain, $lowercaseWord);
-    					array_push($highlighted, $withHighlights);
-    				} else {
-    					//No need to capitalise, so add suggested word
-    					array_push($plain, $lowercaseWord);
+						array_push($plain, $lowercaseWord);
+						array_push($highlighted, $withHighlights);
+					} else {
+						//No need to capitalise, so add suggested word
+						array_push($plain, $lowercaseWord);
 
-    					//No need to capitalise, so add suggested highlighted word
-    					array_push($highlighted, $possiblyUppercaseHighlighted);
-    				}
+						//No need to capitalise, so add suggested highlighted word
+						array_push($highlighted, $possiblyUppercaseHighlighted);
+					}
 				}
 			}
 
@@ -144,37 +144,37 @@ 
 
 		$explanation = explode('-ConstantScore', $explanation)[0];
 
-        $bracketPos = strpos($explanation, ')~');
+		$bracketPos = strpos($explanation, ')~');
 
-        if (substr($explanation, 0,2) == '((') {
-        	$explanation = substr($explanation, 2, $bracketPos-2);
-        } elseif (substr($explanation, 0,1) == '(') {
-        	$explanation = substr($explanation, 1, $bracketPos-2);
-        }
+		if (substr($explanation, 0,2) == '((') {
+			$explanation = substr($explanation, 2, $bracketPos-2);
+		} elseif (substr($explanation, 0,1) == '(') {
+			$explanation = substr($explanation, 1, $bracketPos-2);
+		}
 
-       	$terms = array();
+	   	$terms = array();
 
-        //Field name(s) => terms
-        $splits = explode(' ', $explanation);
+		//Field name(s) => terms
+		$splits = explode(' ', $explanation);
 
-        foreach ($splits as $fieldAndTerm) {
-        	$splits = explode(':', $fieldAndTerm);
+		foreach ($splits as $fieldAndTerm) {
+			$splits = explode(':', $fieldAndTerm);
 
-        	// This is the no terms case
-        	if (sizeof($splits) < 2) {
-        		break;
-        	}
+			// This is the no terms case
+			if (sizeof($splits) < 2) {
+				break;
+			}
 
-        	$fieldname = $splits[0];
-        	$term = $splits[1];
+			$fieldname = $splits[0];
+			$term = $splits[1];
 
-        	if (!isset($terms[$fieldname])) {
-        		$terms[$fieldname] = array();
-        	}
+			if (!isset($terms[$fieldname])) {
+				$terms[$fieldname] = array();
+			}
 
-        	array_push($terms[$fieldname], $term);
-        }
+			array_push($terms[$fieldname], $term);
+		}
 
-        return $terms;
+		return $terms;
 	}
 }

Spacing +11 added lines, -11 removed lines

@@ -58,10 +58,10 @@ 
 			$originalParts = explode(' ', $originalQuery);
 			$suggestedParts = explode(' ', $suggestedPhrase);
 
-			$markedHighlightedParts = ' '.$suggestedPhraseHighlighted.' ';
-			$markedHighlightedParts = str_replace(' '.$preTags, ' '.self::$pre_marker, $markedHighlightedParts);
+			$markedHighlightedParts = ' ' . $suggestedPhraseHighlighted . ' ';
+			$markedHighlightedParts = str_replace(' ' . $preTags, ' ' . self::$pre_marker, $markedHighlightedParts);
 
-			$markedHighlightedParts = str_replace($postTags.' ', self::$post_marker, $markedHighlightedParts);
+			$markedHighlightedParts = str_replace($postTags . ' ', self::$post_marker, $markedHighlightedParts);
 
 			$markedHighlightedParts = trim($markedHighlightedParts);
 			$markedHighlightedParts = trim($markedHighlightedParts);
@@ -91,7 +91,7 @@ 
 				} else {
 					//Need to check capitalisation of terms suggested that are different
 
-					$chr = mb_substr ($possiblyUppercase, 0, 1, "UTF-8");
+					$chr = mb_substr($possiblyUppercase, 0, 1, "UTF-8");
     				if (mb_strtolower($chr, "UTF-8") != $chr) {
     					$upperLowercaseWord = $lowercaseWord;
     					$upperLowercaseWord[0] = $chr;
@@ -115,9 +115,9 @@ 
 				}
 			}
 
-			$highlighted = ' '.implode(' ', $highlighted).' ';
-			$highlighted = str_replace(self::$pre_marker, ' '.$preTags, $highlighted);
-			$highlighted = str_replace(self::$post_marker, $postTags.' ', $highlighted);
+			$highlighted = ' ' . implode(' ', $highlighted) . ' ';
+			$highlighted = str_replace(self::$pre_marker, ' ' . $preTags, $highlighted);
+			$highlighted = str_replace(self::$post_marker, $postTags . ' ', $highlighted);
 
 			$resultArray['suggestedQuery'] = implode(' ', $plain);
 			$resultArray['suggestedQueryHighlighted'] = trim($highlighted);
@@ -146,10 +146,10 @@ 
 
         $bracketPos = strpos($explanation, ')~');
 
-        if (substr($explanation, 0,2) == '((') {
-        	$explanation = substr($explanation, 2, $bracketPos-2);
-        } elseif (substr($explanation, 0,1) == '(') {
-        	$explanation = substr($explanation, 1, $bracketPos-2);
+        if (substr($explanation, 0, 2) == '((') {
+        	$explanation = substr($explanation, 2, $bracketPos - 2);
+        } elseif (substr($explanation, 0, 1) == '(') {
+        	$explanation = substr($explanation, 1, $bracketPos - 2);
         }
 
        	$terms = array();