SemanticMediaWiki / SemanticCompoundQueries

src/CompoundQueryProcessor.php

Doc Comments +8 added lines, -5 removed lines

@@ -132,7 +132,7 @@ 
 	 *
 	 * @param string $param
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	protected static function getSubParams( $param ) {
 		$sub_params = [];
@@ -168,7 +168,7 @@ 
 	 * @param $context
 	 * @param $showmode
 	 *
-	 * @return SMWQueryResult
+	 * @return \SMWQueryResult
 	 */
 	protected static function getQueryResultFromFunctionParams( $rawParams, $context = QueryProcessor::INLINE_QUERY, $showMode = false ) {
 		list( $querystring, $params, $printouts ) = self::getComponentsFromFunctionParams( $rawParams, $showMode );
@@ -180,7 +180,7 @@ 
 	 * Combine two arrays of SMWWikiPageValue objects into one
 	 *
 	 * @param array $result1
-	 * @param array $result2
+	 * @param \SMWDIWikiPage[] $result2
 	 *
 	 * @return array
 	 */
@@ -204,6 +204,9 @@ 
 		return $result1;
 	}
 
+	/**
+	 * @param \SMW\Query\PrintRequest[] $printRequests2
+	 */
 	protected static function mergeSMWPrintRequests( $printRequests1, $printRequests2 ) {
 		$existingPrintoutLabels = [];
 		foreach ( $printRequests1 as $p1 ) {
@@ -226,7 +229,7 @@ 
 	 * @param $outputMode
 	 * @param $context
 	 *
-	 * @return SMWQueryResult
+	 * @return \SMWQueryResult
 	 */
 	protected static function getQueryResultFromQueryString( $querystring, array $params, $extraPrintouts, $context = QueryProcessor::INLINE_QUERY ) {
 
@@ -262,7 +265,7 @@ 
 	 *
 	 * @param CompoundQueryResult $res
 	 * @param array $params These need to be the result of a list fed to getProcessedParams as of SMW 1.6.2
-	 * @param $outputmode
+	 * @param integer $outputmode
 	 * @param $context
 	 * @param string $format
 	 *

Spacing +63 added lines, -63 removed lines

@@ -21,13 +21,13 @@ 
 	/**
 	 * Comparison helper function, used in sorting results.
 	 */
-	public static function compareQueryResults( $a, $b ) {
+	public static function compareQueryResults($a, $b) {
 
-		if ( $a->getSerialization() == $b->getSerialization() ) {
+		if ($a->getSerialization() == $b->getSerialization()) {
 			return 0;
 		}
 
-		return ( $a->getSerialization() < $b->getSerialization() ) ? -1 : 1;
+		return ($a->getSerialization() < $b->getSerialization()) ? -1 : 1;
 	}
 
 	/**
@@ -37,20 +37,20 @@ 
 	 *
 	 * @return string
 	 */
-	public static function doCompoundQuery( Parser &$parser ) {
+	public static function doCompoundQuery(Parser &$parser) {
 		global $smwgQEnabled, $smwgIQRunningNumber;
 
-		if ( !$smwgQEnabled ) {
-			return smwfEncodeMessages( [ wfMessage( 'smw_iq_disabled' )->inContentLanguage()->text() ] );
+		if (!$smwgQEnabled) {
+			return smwfEncodeMessages([wfMessage('smw_iq_disabled')->inContentLanguage()->text()]);
 		}
 
 		$smwgIQRunningNumber++;
 
 		$params = func_get_args();
-		array_shift( $params ); // We already know the $parser.
+		array_shift($params); // We already know the $parser.
 
-		list( $queryParams, $otherParams ) = self::separateParams( $params );
-		list( $queryResult, $otherParams ) = self::queryAndMergeResults( $queryParams, $otherParams );
+		list($queryParams, $otherParams) = self::separateParams($params);
+		list($queryResult, $otherParams) = self::queryAndMergeResults($queryParams, $otherParams);
 
 		return self::getResultFromQueryResult(
 			$queryResult,
@@ -65,25 +65,25 @@ 
 	 * @param $params
 	 * @return array
 	 */
-	public static function separateParams( $params ) {
+	public static function separateParams($params) {
 		$queryParams = [];
 		$otherParams = [];
 
-		foreach ( $params as $param ) {
+		foreach ($params as $param) {
 			// Very primitive heuristic - if the parameter
 			// includes a square bracket, then it's a
 			// sub-query; otherwise it's a regular parameter.
-			if ( strpos( $param, '[' ) !== false ) {
+			if (strpos($param, '[') !== false) {
 				$queryParams[] = $param;
 			} else {
-				$parts = explode( '=', $param, 2 );
+				$parts = explode('=', $param, 2);
 
-				if ( count( $parts ) >= 2 ) {
-					$otherParams[strtolower( trim( $parts[0] ) )] = $parts[1]; // don't trim here, some params care for " "
+				if (count($parts) >= 2) {
+					$otherParams[strtolower(trim($parts[0]))] = $parts[1]; // don't trim here, some params care for " "
 				}
 			}
 		}
-		return [ $queryParams, $otherParams ];
+		return [$queryParams, $otherParams];
 	}
 
 	/**
@@ -93,36 +93,36 @@ 
 	 * @param $otherParams
 	 * @return array
 	 */
-	public static function queryAndMergeResults( $queryParams, $otherParams ) {
+	public static function queryAndMergeResults($queryParams, $otherParams) {
 		$results = [];
 		$printRequests = [];
 
-		foreach ( $queryParams as $param ) {
-			$subQueryParams = self::getSubParams( $param );
+		foreach ($queryParams as $param) {
+			$subQueryParams = self::getSubParams($param);
 
-			if ( array_key_exists( 'format', $otherParams ) && !array_key_exists( 'format', $subQueryParams ) ) {
+			if (array_key_exists('format', $otherParams) && !array_key_exists('format', $subQueryParams)) {
 				$subQueryParams['format'] = $otherParams['format'];
 			}
 
 			$nextResult = self::getQueryResultFromFunctionParams($subQueryParams);
 
-			$results = self::mergeSMWQueryResults( $results, $nextResult->getResults() );
-			$printRequests = self::mergeSMWPrintRequests( $printRequests, $nextResult->getPrintRequests() );
+			$results = self::mergeSMWQueryResults($results, $nextResult->getResults());
+			$printRequests = self::mergeSMWPrintRequests($printRequests, $nextResult->getPrintRequests());
 		}
 
 		// Sort results so that they'll show up by page name
-		if( !isset($otherParams['unsorted']) || !strcmp( $otherParams['unsorted'], 'on' ) ) {
-			uasort( $results, [ '\SCQ\CompoundQueryProcessor', 'compareQueryResults' ] );
+		if (!isset($otherParams['unsorted']) || !strcmp($otherParams['unsorted'], 'on')) {
+			uasort($results, ['\SCQ\CompoundQueryProcessor', 'compareQueryResults']);
 		}
 
-		$queryResult = new CompoundQueryResult( $printRequests, new Query(), $results, smwfGetStore() );
+		$queryResult = new CompoundQueryResult($printRequests, new Query(), $results, smwfGetStore());
 
-		if ( version_compare( SMW_VERSION, '1.6.1', '>' ) ) {
-			self::addThisPrintout( $printRequests, $otherParams );
-			$otherParams = self::getProcessedParams( $otherParams, $printRequests );
+		if (version_compare(SMW_VERSION, '1.6.1', '>')) {
+			self::addThisPrintout($printRequests, $otherParams);
+			$otherParams = self::getProcessedParams($otherParams, $printRequests);
 		}
 
-		return [ $queryResult, $otherParams ];
+		return [$queryResult, $otherParams];
 	}
 
 	/**
@@ -134,31 +134,31 @@ 
 	 *
 	 * @return array
 	 */
-	protected static function getSubParams( $param ) {
+	protected static function getSubParams($param) {
 		$sub_params = [];
 		$sub_param = '';
 		$uncompleted_square_brackets = 0;
 
-		for ( $i = 0; $i < strlen( $param ); $i++ ) {
+		for ($i = 0; $i < strlen($param); $i++) {
 			$c = $param[$i];
 
-			if ( ( $c == ';' ) && ( $uncompleted_square_brackets <= 0 ) ) {
-				$sub_params[] = trim( $sub_param );
+			if (($c == ';') && ($uncompleted_square_brackets <= 0)) {
+				$sub_params[] = trim($sub_param);
 				$sub_param = '';
 			} else {
 				$sub_param .= $c;
 
-				if ( $c == '[' ) {
+				if ($c == '[') {
 					$uncompleted_square_brackets++;
 				}
 
-				elseif ( $c == ']' ) {
+				elseif ($c == ']') {
 					$uncompleted_square_brackets--;
 				}
 			}
 		}
 
-		$sub_params[] = trim( $sub_param );
+		$sub_params[] = trim($sub_param);
 
 		return $sub_params;
 	}
@@ -170,10 +170,10 @@ 
 	 *
 	 * @return SMWQueryResult
 	 */
-	protected static function getQueryResultFromFunctionParams( $rawParams, $context = QueryProcessor::INLINE_QUERY, $showMode = false ) {
-		list( $querystring, $params, $printouts ) = self::getComponentsFromFunctionParams( $rawParams, $showMode );
+	protected static function getQueryResultFromFunctionParams($rawParams, $context = QueryProcessor::INLINE_QUERY, $showMode = false) {
+		list($querystring, $params, $printouts) = self::getComponentsFromFunctionParams($rawParams, $showMode);
 
-		return self::getQueryResultFromQueryString( $querystring, $params, $printouts, $context );
+		return self::getQueryResultFromQueryString($querystring, $params, $printouts, $context);
 	}
 
 	/**
@@ -184,19 +184,19 @@ 
 	 *
 	 * @return array
 	 */
-	protected static function mergeSMWQueryResults( $result1, $result2 ) {
-		if ( $result1 == null ) {
+	protected static function mergeSMWQueryResults($result1, $result2) {
+		if ($result1 == null) {
 			return $result2;
 		}
 
 		$existing_page_names = [];
-		foreach ( $result1 as $r1 ) {
+		foreach ($result1 as $r1) {
 			$existing_page_names[] = $r1->getSerialization();
 		}
 
-		foreach ( $result2 as $r2 ) {
+		foreach ($result2 as $r2) {
 			$page_name = $r2->getSerialization();
-			if ( ! in_array( $page_name, $existing_page_names ) ) {
+			if (!in_array($page_name, $existing_page_names)) {
 				$result1[] = $r2;
 			}
 		}
@@ -204,15 +204,15 @@ 
 		return $result1;
 	}
 
-	protected static function mergeSMWPrintRequests( $printRequests1, $printRequests2 ) {
+	protected static function mergeSMWPrintRequests($printRequests1, $printRequests2) {
 		$existingPrintoutLabels = [];
-		foreach ( $printRequests1 as $p1 ) {
+		foreach ($printRequests1 as $p1) {
 			$existingPrintoutLabels[] = $p1->getLabel();
 		}
 
-		foreach ( $printRequests2 as $p2 ) {
+		foreach ($printRequests2 as $p2) {
 			$label = $p2->getLabel();
-			if ( ! in_array( $label, $existingPrintoutLabels ) ) {
+			if (!in_array($label, $existingPrintoutLabels)) {
 				$printRequests1[] = $p2;
 			}
 		}
@@ -228,20 +228,20 @@ 
 	 *
 	 * @return SMWQueryResult
 	 */
-	protected static function getQueryResultFromQueryString( $querystring, array $params, $extraPrintouts, $context = QueryProcessor::INLINE_QUERY ) {
+	protected static function getQueryResultFromQueryString($querystring, array $params, $extraPrintouts, $context = QueryProcessor::INLINE_QUERY) {
 
-		if ( version_compare( SMW_VERSION, '1.6.1', '>' ) ) {
-			QueryProcessor::addThisPrintout( $extraPrintouts, $params );
-			$params = self::getProcessedParams( $params, $extraPrintouts, false );
+		if (version_compare(SMW_VERSION, '1.6.1', '>')) {
+			QueryProcessor::addThisPrintout($extraPrintouts, $params);
+			$params = self::getProcessedParams($params, $extraPrintouts, false);
 		}
 
-		$query = self::createQuery( $querystring, $params, $context, null, $extraPrintouts );
-		$queryResult = smwfGetStore()->getQueryResult( $query );
+		$query = self::createQuery($querystring, $params, $context, null, $extraPrintouts);
+		$queryResult = smwfGetStore()->getQueryResult($query);
 
 		$parameters = [];
 
-		if ( version_compare( SMW_VERSION, '1.7.2', '>' ) ) {
-			foreach ( $params as $param ) {
+		if (version_compare(SMW_VERSION, '1.7.2', '>')) {
+			foreach ($params as $param) {
 				$parameters[$param->getName()] = $param->getValue();
 			}
 		}
@@ -249,7 +249,7 @@ 
 			$parameters = $params;
 		}
 
-		foreach ( $queryResult->getResults() as $wikiPage ) {
+		foreach ($queryResult->getResults() as $wikiPage) {
 			$wikiPage->display_options = $parameters;
 		}
 
@@ -268,20 +268,20 @@ 
 	 *
 	 * @return string
 	 */
-	protected static function getResultFromQueryResult( CompoundQueryResult $res, array $params, $outputmode, $context = QueryProcessor::INLINE_QUERY, $format = '' ) {
+	protected static function getResultFromQueryResult(CompoundQueryResult $res, array $params, $outputmode, $context = QueryProcessor::INLINE_QUERY, $format = '') {
 
-		if ( version_compare( SMW_VERSION, '1.6.1', '>' ) ) {
+		if (version_compare(SMW_VERSION, '1.6.1', '>')) {
 			$format = $params['format'];
 
-			if ( version_compare( SMW_VERSION, '1.7.2', '>' ) ) {
+			if (version_compare(SMW_VERSION, '1.7.2', '>')) {
 				$format = $format->getValue();
 			}
 		} else {
-			$format = self::getResultFormat( $params );
+			$format = self::getResultFormat($params);
 		}
 
-		$printer = self::getResultPrinter( $format, $context );
-		$result = $printer->getResult( $res, $params, $outputmode );
+		$printer = self::getResultPrinter($format, $context);
+		$result = $printer->getResult($res, $params, $outputmode);
 
 		return $result;
 	}