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

Spacing +29 added lines, -29 removed lines

@@ -8,8 +8,8 @@ 
 	public static $ignoreFixtureFileFor = array();
 
 	protected $extraDataObjects = array(
-		'SearchableTestPage','FlickrPhotoTO','FlickrAuthorTO','FlickrSetTO','FlickrTagTO',
-		'SearchableTestFatherPage','SearchableTestGrandFatherPage','AutoCompleteOption'
+		'SearchableTestPage', 'FlickrPhotoTO', 'FlickrAuthorTO', 'FlickrSetTO', 'FlickrTagTO',
+		'SearchableTestFatherPage', 'SearchableTestGrandFatherPage', 'AutoCompleteOption'
 	);
 
 
@@ -40,7 +40,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;
 
@@ -50,7 +50,7 @@ 
 		$this->service->setTestMode(true);
 
 		// A previous test may have deleted the index and then failed, so check for this
-		if (!$this->service->getIndex()->exists()) {
+		if(!$this->service->getIndex()->exists()) {
 			$this->service->getIndex()->create();
 		}
 		$this->service->reset();
@@ -61,9 +61,9 @@ 
 
 		$orig_fixture_file = static::$fixture_file;
 
-		foreach (static::$ignoreFixtureFileFor as $testPattern) {
-			$pattern = '/'.$testPattern.'/';
-			if (preg_match($pattern, $this->getName())) {
+		foreach(static::$ignoreFixtureFileFor as $testPattern) {
+			$pattern = '/' . $testPattern . '/';
+			if(preg_match($pattern, $this->getName())) {
 				static::$fixture_file = null;
 			}
 		}
@@ -92,55 +92,55 @@ 
 
 
 	private function publishSiteTree() {
-		foreach (SiteTree::get()->getIterator() as $page) {
+		foreach(SiteTree::get()->getIterator() as $page) {
 			// temporarily disable Elasticsearch indexing, it will be done in a batch
 			$page->IndexingOff = true;
-			$page->publish('Stage','Live');
+			$page->publish('Stage', 'Live');
 		}
 	}
 
 
 	public function generateAssertionsFromArray($toAssert) {
-		echo '$expected = array('."\n";
-		foreach ($toAssert as $key => $value) {
+		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";
-		foreach ($toAssert as $key => $value) {
+		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);
+		foreach($toAssert as $key => $value) {
+			if(is_array($value)) {
+				$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";
@@ -164,7 +164,7 @@ 
 		$size = sizeof($splits);
 		$nameToCheck = end($splits);
 		$this->assertEquals($actualTabName, $nameToCheck);
-		if ($size == 1) {
+		if($size == 1) {
 			$this->assertEquals("Root_${tabName}", $tab->id());
 		} else {
 			$expected = "Root_{$splits[0]}_set_{$splits[1]}";
@@ -175,7 +175,7 @@ 
 	}
 
 
-	public function checkFieldExists($tab,$fieldName) {
+	public function checkFieldExists($tab, $fieldName) {
 		$fields = $tab->Fields();
 		$field = $tab->fieldByName($fieldName);
 		$this->assertTrue($field != null);
@@ -209,14 +209,14 @@ 
 
 		$numberDocsInIndex = -1; // flag value for not yet indexed
 		error_log('CHECKING NUMBER OF INDEXED DOCUMENTS, SHOULD BE ' . $expectedAmount);
-		error_log(print_r($status,1));
+		error_log(print_r($status, 1));
 
-		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
+		if(isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
 			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
-			error_log('DOCUMENTS FOUND:'.$numberDocsInIndex);
+			error_log('DOCUMENTS FOUND:' . $numberDocsInIndex);
 		}
 
-		$this->assertEquals($expectedAmount,$numberDocsInIndex);
+		$this->assertEquals($expectedAmount, $numberDocsInIndex);
 	}
 
 	/*
@@ -227,7 +227,7 @@ 
 		$status = $index->getStatus()->getData();
 
 		$numberDocsInIndex = -1; // flag value for not yet indexed
-		if (isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
+		if(isset($status['indices']['elastica_ss_module_test_en_us']['docs'])) {
 			$numberDocsInIndex = $status['indices']['elastica_ss_module_test_en_us']['docs']['num_docs'];
 		}