Merge pull request #4172 from SemanticMediaWiki/ProcessedParam

Stop using long deprecated ParamProcessor stuff

includes/query/SMW_QueryProcessor.php

@@ -1,11 +1,10 @@
 <?php
 
 use ParamProcessor\Options;
-use ParamProcessor\Param;
 use ParamProcessor\ParamDefinition;
+use ParamProcessor\ProcessedParam;
 use ParamProcessor\Processor;
 use SMW\ApplicationFactory;
-use SMW\Message;
 use SMW\Parser\RecursiveTextProcessor;
 use SMW\Query\Deferred;
 use SMW\Query\PrintRequest;
@@ -14,6 +13,8 @@
 use SMW\Query\QueryContext;
 use SMW\Query\Exception\ResultFormatNotFoundException;
 use SMW\Query\ResultFormat;
+use SMW\Query\ResultPrinter;
+use SMW\Query\ResultPrinters\NullResultPrinter;
 
 /**
  * This file contains a static class for accessing functions to generate and execute
@@ -52,26 +53,35 @@ public static function setRecursiveTextProcessor( RecursiveTextProcessor $recurs
 	 * param name (string) => param value (mixed)
 	 *
 	 * @since 1.6.2
-	 * The return value changed in SMW 1.8 from an array with result values
-	 * to an array with Param objects.
+	 * The return value changed in SMW 3.1 from Param[] to ProcessedParam[]
 	 *
 	 * @param array $params
-	 * @param array $printRequests
+	 * @param PrintRequest[] $printRequests
 	 * @param boolean $unknownInvalid
 	 *
-	 * @return Param[]
+	 * @return ProcessedParam[]
 	 */
 	public static function getProcessedParams( array $params, array $printRequests = [], $unknownInvalid = true, $context = null, $showMode = false ) {
-		$validator = self::getValidatorForParams( $params, $printRequests, $unknownInvalid, $context, $showMode );
-		$validator->processParameters();
-		$parameters =  $validator->getParameters();
-
-		// Negates some weird behaviour of ParamDefinition::setDefault used in
-		// an individual printer.
-		// Applying $smwgQMaxLimit, $smwgQMaxInlineLimit will happen at a later
-		// stage.
+		$validator = self::getProcessorForParams( $params, $printRequests, $unknownInvalid, $context, $showMode );
+		$processingResult = $validator->processParameters();
+
+		$parameters = [];
+
+		foreach ( $processingResult->getParameters() as $parameter ) {
+			$parameters[$parameter->getName()] = $parameter;
+		}
+
+		// Set limit parameter to its original value.
+		// This is to allow for special handling of invalid values rather than just setting the parameter to its default.
+		// $smwgQMaxLimit and $smwgQMaxInlineLimit will be applied at a later point.
 		if ( isset( $params['limit'] ) && isset( $parameters['limit'] ) ) {
-			$parameters['limit']->setValue( (int)$params['limit'] );
+			$parameters['limit'] = new ProcessedParam(
+				'limit',
+				(int)$params['limit'],
+				false,
+				'limit',
+				(int)$params['limit']
+			);
 		}
 
 		return $parameters;
@@ -228,7 +238,9 @@ static public function processFunctionParams( array $rawParams, &$querystring, &
 	 * @return array( string, array( string => string ), array( SMWPrintRequest ) )
 	 */
 	static public function getComponentsFromFunctionParams( array $rawParams, $showMode ) {
-
+		/**
+		 * @var ParamListProcessor $paramListProcessor
+		 */
 		$paramListProcessor = ApplicationFactory::getInstance()->singleton( 'ParamListProcessor' );
 
 		return $paramListProcessor->format(
@@ -252,7 +264,7 @@ static public function getComponentsFromFunctionParams( array $rawParams, $showM
 	 * @param integer $outputMode SMW_OUTPUT_WIKI, SMW_OUTPUT_HTML, ...
 	 * @param integer $context INLINE_QUERY, SPECIAL_PAGE, CONCEPT_DESC
 	 * @param boolean $showMode process like #show parser function?
-	 * @return array( SMWQuery, array of IParam )
+	 * @return array( SMWQuery, ProcessedParam[] )
 	 */
 	static public function getQueryAndParamsFromFunctionParams( array $rawParams, $outputMode, $context, $showMode, $contextPage = null ) {
 		list( $queryString, $params, $printouts ) = self::getComponentsFromFunctionParams( $rawParams, $showMode );
@@ -436,7 +448,7 @@ public static function getResultFromQuery( SMWQuery $query, array $params, $outp
 	 * @param $context
 	 *
 	 * @return SMWResultPrinter
-	 * @throws MissingResultFormatException
+	 * @throws ResultFormatNotFoundException
 	 */
 	static public function getResultPrinter( $format, $context = self::SPECIAL_PAGE ) {
 		global $smwgResultFormats;
@@ -449,6 +461,9 @@ static public function getResultPrinter( $format, $context = self::SPECIAL_PAGE
 
 		$formatClass = $smwgResultFormats[$format];
 
+		/**
+		 * @var SMWResultPrinter $printer
+		 */
 		$printer = new $formatClass( $format, ( $context != self::SPECIAL_PAGE ) );
 
 		if ( self::$recursiveTextProcessor === null ) {
@@ -471,7 +486,7 @@ static public function getResultPrinter( $format, $context = self::SPECIAL_PAGE
 	 * @param integer|null $context
 	 * @param ResultPrinter|null $resultPrinter
 	 *
-	 * @return IParamDefinition[]
+	 * @return ParamDefinition[]
 	 */
 	public static function getParameters( $context = null, $resultPrinter = null ) {
 		return DefaultParamDefinition::getParamDefinitions( $context, $resultPrinter );
@@ -495,7 +510,7 @@ public static function getFormatParameters( $format ) {
 
 		$resultPrinter = self::getResultPrinter( $format );
 
-		if ( $resultPrinter instanceof \SMW\Query\ResultPrinters\NullResultPrinter ) {
+		if ( $resultPrinter instanceof NullResultPrinter ) {
 			return [];
 		}
 
@@ -509,28 +524,31 @@ public static function getFormatParameters( $format ) {
 	 * and sets them on a new Validator object,
 	 * which is returned and ready to process the parameters.
 	 *
-	 * @since 1.8
-	 *
 	 * @param array $params
-	 * @param array $printRequests
+	 * @param PrintRequest[] $printRequests
 	 * @param boolean $unknownInvalid
 	 *
 	 * @return Processor
 	 */
-	private static function getValidatorForParams( array $params, array $printRequests = [], $unknownInvalid = true, $context = null, $showMode = false ) {
+	private static function getProcessorForParams( array $params, array $printRequests = [], $unknownInvalid = true, $context = null, $showMode = false ) {
 		$paramDefinitions = self::getParameters( $context );
 
-		$paramDefinitions['format']->setPrintRequests( $printRequests );
-		$paramDefinitions['format']->setShowMode( $showMode );
+		/**
+		 * @var ResultFormat $formatParameter
+		 */
+		$formatParameter = $paramDefinitions['format'];
+
+		$formatParameter->setPrintRequests( $printRequests );
+		$formatParameter->setShowMode( $showMode );
 
 		$processorOptions = new Options();
 		$processorOptions->setUnknownInvalid( $unknownInvalid );
 
-		$validator = Processor::newFromOptions( $processorOptions );
+		$processor = Processor::newFromOptions( $processorOptions );
 
-		$validator->setParameters( $params, $paramDefinitions, false );
+		$processor->setParameters( $params, $paramDefinitions );
 
-		return $validator;
+		return $processor;
 	}
 
 }

src/Query/Processor/DefaultParamDefinition.php

@@ -25,7 +25,7 @@ class DefaultParamDefinition {
 	 * @param integer|null $context
 	 * @param ResultPrinter|null $resultPrinter
 	 *
-	 * @return IParamDefinition[]
+	 * @return ParamDefinition[]
 	 */
 	public static function getParamDefinitions( $context = null, ResultPrinter $resultPrinter = null ) {
 		return self::buildParamDefinitions( $GLOBALS, $context, $resultPrinter );
@@ -47,7 +47,7 @@ public static function getParamDefinitions( $context = null, ResultPrinter $resu
 	 * @param integer|null $context
 	 * @param ResultPrinter|null $resultPrinter
 	 *
-	 * @return IParamDefinition[]
+	 * @return ParamDefinition[]
 	 */
 	public static function buildParamDefinitions( $vars, $context = null, ResultPrinter $resultPrinter = null ) {
 		$params = [];

src/Query/ResultFormat.php

@@ -4,7 +4,7 @@
 
 use ParamProcessor\Definition\StringParam;
 use ParamProcessor\IParam;
-use SMW\Query\PrintRequest;
+use ParamProcessor\IParamDefinition;
 use SMWQueryProcessor as QueryProcessor;
 
 /**

src/Query/ResultPrinter.php

@@ -2,6 +2,7 @@
 
 namespace SMW\Query;
 
+use ParamProcessor\ParamDefinition;
 use SMWQueryResult as QueryResult;
 
 /**