gordonbanderson / silverstripe-elastica

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();

tests/ElasticSearcherUnitTest.php

Spacing +11 added lines, -11 removed lines

@@ -21,7 +21,7 @@ 
 		$es->setLocale($locale);
 		$es->setClasses('FlickrPhotoTO');
 
-		$fields = array('Description' => 1,'Title' => 1);
+		$fields = array('Description' => 1, 'Title' => 1);
 		$results = $es->search('New Zealind', $fields, true);
 
 		$this->assertEquals('New Zealand', $es->getSuggestedQuery());
@@ -48,7 +48,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";
@@ -69,7 +69,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');
 
@@ -137,7 +137,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();
@@ -163,7 +163,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();
@@ -226,12 +226,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');
 			}
 		}
 	}
@@ -256,12 +256,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');
 			}
 		}
 	}
@@ -283,9 +283,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++;
 		}
 	}

Doc Comments +3 added lines

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

tests/SearchableTest.php

Indentation +3 added lines, -3 removed lines

@@ -553,10 +553,10 @@
 		print_r($sr);
 
 
-    	//$sr2 = array('Photographer', 'FlickrTagTOs', 'FlickrSetTOs');
+		//$sr2 = array('Photographer', 'FlickrTagTOs', 'FlickrSetTOs');
 
-    	// MUST REMOVE FIRST.  Otherwise append and the erroroneus value above still exists
-    	$config->remove('FlickrPhotoTO', 'searchable_relationships');
+		// MUST REMOVE FIRST.  Otherwise append and the erroroneus value above still exists
+		$config->remove('FlickrPhotoTO', 'searchable_relationships');
 		$config->update('FlickrPhotoTO' ,'searchable_relationships', $sr);
 	}
 

Spacing +27 added lines, -27 removed lines

@@ -13,7 +13,7 @@ 
 	public function setUp() {
 		// 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', 'FlickrSetTO');
 		$this->requireDefaultRecordsFrom = $classes;
 
@@ -188,15 +188,15 @@ 
 
 
 		// check strings
-		$shouldBeString = array('Title','Description');
-		$shouldBeInt = array('ISO','FlickrID','FocalLength35mm');
+		$shouldBeString = array('Title', 'Description');
+		$shouldBeInt = array('ISO', 'FlickrID', 'FocalLength35mm');
 		$shouldBeBoolean = array('IsInSiteTree');
 		$shouldBeDouble = array('Aperture');
 		$shouldBeDateTime = array('TakenAt');
 		$shouldBeDate = array('FirstViewed');
 
 		// tokens are strings that have analyzer 'not_analyzed', namely the string is indexed as is
-		$shouldBeTokens = array('ShutterSpeed','Link');
+		$shouldBeTokens = array('ShutterSpeed', 'Link');
 
 
 		// check strings
@@ -213,7 +213,7 @@ 
 
 			// check for unstemmed analaysis
 
-			$this->assertEquals($expectedStandardArray,$fieldProperties['fields']['standard']);
+			$this->assertEquals($expectedStandardArray, $fieldProperties['fields']['standard']);
 
 			// check for only 3 entries
 			$this->assertEquals(4, sizeof(array_keys($fieldProperties)));
@@ -224,7 +224,7 @@ 
 			$fieldProperties = $properties[$fieldName];
 			$type = $fieldProperties['type'];
 			$this->assertEquals(1, sizeof(array_keys($fieldProperties)));
-			$this->assertEquals('integer',$type);
+			$this->assertEquals('integer', $type);
 		}
 
 
@@ -233,7 +233,7 @@ 
 			$fieldProperties = $properties[$fieldName];
 			$type = $fieldProperties['type'];
 			$this->assertEquals(1, sizeof(array_keys($fieldProperties)));
-			$this->assertEquals('double',$type);
+			$this->assertEquals('double', $type);
 		}
 
 		// check boolean
@@ -241,7 +241,7 @@ 
 			$fieldProperties = $properties[$fieldName];
 			$type = $fieldProperties['type'];
 			$this->assertEquals(1, sizeof(array_keys($fieldProperties)));
-			$this->assertEquals('boolean',$type);
+			$this->assertEquals('boolean', $type);
 		}
 
 
@@ -249,7 +249,7 @@ 
 			$fieldProperties = $properties[$fieldName];
 			$type = $fieldProperties['type'];
 			$this->assertEquals(2, sizeof(array_keys($fieldProperties)));
-			$this->assertEquals('date',$type);
+			$this->assertEquals('date', $type);
 			$this->assertEquals('y-M-d', $fieldProperties['format']);
 		}
 
@@ -260,7 +260,7 @@ 
 			$fieldProperties = $properties[$fieldName];
 			$type = $fieldProperties['type'];
 			$this->assertEquals(2, sizeof(array_keys($fieldProperties)));
-			$this->assertEquals('date',$type);
+			$this->assertEquals('date', $type);
 			$this->assertEquals('y-M-d H:m:s', $fieldProperties['format']);
 		}
 
@@ -299,7 +299,7 @@ 
 		$doc = $flickrPhoto->getElasticaDocument()->getData();
 
 		$expected = array();
-		$expected['Title'] = 'Bangkok' ;
+		$expected['Title'] = 'Bangkok';
 		$expected['FlickrID'] = '1234567';
 		$expected['Description'] = 'Test photograph';
 		$expected['TakenAt'] = '2011-07-04 20:36:00';
@@ -388,7 +388,7 @@ 
 		$page = $this->objFromFixture('SiteTree', 'sitetree001');
 		$page->doUnpublish();
 
-		$this->checkNumberOfIndexedDocuments($nDocsAtStart-1);
+		$this->checkNumberOfIndexedDocuments($nDocsAtStart - 1);
 
 		$page->doPublish();
 		$this->checkNumberOfIndexedDocuments($nDocsAtStart);
@@ -481,7 +481,7 @@ 
 		$flickrPhoto = $this->objFromFixture('FlickrPhotoTO', 'photo0001');
 		$fields = $flickrPhoto->getCMSFields();
 
-		$tab = $this->checkTabExists($fields,'ElasticaTermsset');
+		$tab = $this->checkTabExists($fields, 'ElasticaTermsset');
 	}
 
 
@@ -497,7 +497,7 @@ 
 			$this->assertEquals('The field $searchable_fields must be set for the class FlickrPhotoTO', $e->getMessage());
 		}
 
-		$config->update('FlickrPhotoTO' ,'searchable_fields', $sf);
+		$config->update('FlickrPhotoTO', 'searchable_fields', $sf);
 	}
 
 
@@ -513,7 +513,7 @@ 
 			$this->assertEquals('The field $searchable_fields must be set for the class FlickrTagTO', $e->getMessage());
 		}
 
-		$config->update('FlickrTagTO' ,'searchable_fields', $sf);
+		$config->update('FlickrTagTO', 'searchable_fields', $sf);
 
 	}
 
@@ -530,7 +530,7 @@ 
 			$this->assertEquals('The field $searchable_fields must be set for the class FlickrAuthorTO', $e->getMessage());
 		}
 
-		$config->update('FlickrAuthorTO' ,'searchable_fields', $sf);
+		$config->update('FlickrAuthorTO', 'searchable_fields', $sf);
 
 	}
 
@@ -539,7 +539,7 @@ 
 		$config = Config::inst();
 		$sr = $config->get('FlickrPhotoTO', 'searchable_relationships');
 		$config->remove('FlickrPhotoTO', 'searchable_relationships');
-		$config->update('FlickrPhotoTO', 'searchable_relationships',array('thisMethodDoesNotExist'));
+		$config->update('FlickrPhotoTO', 'searchable_relationships', array('thisMethodDoesNotExist'));
 		$fp = Injector::inst()->create('FlickrPhotoTO');
 		try {
 			$fields = $fp->getAllSearchableFields();
@@ -557,7 +557,7 @@ 
 
     	// MUST REMOVE FIRST.  Otherwise append and the erroroneus value above still exists
     	$config->remove('FlickrPhotoTO', 'searchable_relationships');
-		$config->update('FlickrPhotoTO' ,'searchable_relationships', $sr);
+		$config->update('FlickrPhotoTO', 'searchable_relationships', $sr);
 	}
 
 
@@ -669,9 +669,9 @@ 
 
 		$photographer->write();
 
-		$flickrPhoto->PhotographerID = $photographer->ID;;
+		$flickrPhoto->PhotographerID = $photographer->ID; ;
 		$flickrPhoto->write();
-		echo 'ID='.$flickrPhoto->PhotographerID;
+		echo 'ID=' . $flickrPhoto->PhotographerID;
 		$a = $flickrPhoto->getFieldValuesAsArray();
 
 		print_r($a);
@@ -718,7 +718,7 @@ 
 
 
 		$flickrPhoto->write();
-		echo 'ID='.$flickrPhoto->PhotographerID;
+		echo 'ID=' . $flickrPhoto->PhotographerID;
 		$a = $flickrPhoto->getFieldValuesAsArray();
 
 		print_r($a);
@@ -766,15 +766,15 @@ 
 			foreach ($tab->FieldList() as $field) {
 				array_push($tabFields, $field->getName());
 			}
-			$expectedName = 'TermsFor'.$tab->getName();;
+			$expectedName = 'TermsFor' . $tab->getName(); ;
 			$expected = array($expectedName);
 			$this->assertEquals($expected, $tabFields);
 			array_push($tabNames, $tab->getName());
 		}
-		$expected = array('Description','Description_shingles','Description_standard',
-			'ShutterSpeed',  'TestMethod', 'TestMethod_shingles', 'TestMethod_standard',
+		$expected = array('Description', 'Description_shingles', 'Description_standard',
+			'ShutterSpeed', 'TestMethod', 'TestMethod_shingles', 'TestMethod_standard',
 			'TestMethodHTML', 'TestMethodHTML_shingles', 'TestMethodHTML_standard',
-			'Title','Title_autocomplete','Title_shingles','Title_standard');
+			'Title', 'Title_autocomplete', 'Title_shingles', 'Title_standard');
 
 		$this->assertEquals($expected, $tabNames);
 	}
@@ -798,13 +798,13 @@ 
 			foreach ($tab->FieldList() as $field) {
 				array_push($tabFields, $field->getName());
 			}
-			$expectedName = 'TermsFor'.$tab->getName();;
+			$expectedName = 'TermsFor' . $tab->getName(); ;
 			$expected = array($expectedName);
 			$this->assertEquals($expected, $tabFields);
 			array_push($tabNames, $tab->getName());
 		}
 		$expected = array(
-			'Content','Content_standard','Link','Title','Title_autocomplete','Title_shingles',
+			'Content', 'Content_standard', 'Link', 'Title', 'Title_autocomplete', 'Title_shingles',
 			'Title_standard');
 		$this->generateAssertionsFromArray1D($tabNames);
 		$this->assertEquals($expected, $tabNames);

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