Used named parameters for with_variable function

nyalldawson · nyalldawson · commit 89cd7858e54d · 2018-08-23T21:15:32.000+10:00
diff --git a/resources/function_help/json/with_variable b/resources/function_help/json/with_variable
@@ -5,7 +5,7 @@
   "arguments": [
                  {"arg":"name","description":"the name of the variable to set"},
                  {"arg":"value","description":"the value to set"},
-                 {"arg":"node","description":"the expression for which the variable will be available"}
+                 {"arg":"expression","description":"the expression for which the variable will be available"}
                ],
   "examples": [ { "expression":"with_variable('my_sum', 1 + 2 + 3, @my_sum * 2 + @my_sum * 5)", "returns":"42"}]
 }
diff --git a/src/core/expression/qgsexpressionfunction.cpp b/src/core/expression/qgsexpressionfunction.cpp
@@ -4863,7 +4863,11 @@ bool QgsArrayForeachExpressionFunction::prepare( const QgsExpressionNodeFunction
 }
 
 QgsWithVariableExpressionFunction::QgsWithVariableExpressionFunction()
-  : QgsExpressionFunction( QStringLiteral( "with_variable" ), 3, QCoreApplication::tr( "General" ) )
+  : QgsExpressionFunction( QStringLiteral( "with_variable" ), QgsExpressionFunction::ParameterList() <<
+                           QgsExpressionFunction::Parameter( QStringLiteral( "name" ) )
+                           << QgsExpressionFunction::Parameter( QStringLiteral( "value" ) )
+                           << QgsExpressionFunction::Parameter( QStringLiteral( "expression" ) ),
+                           QCoreApplication::tr( "General" ) )
 {
 
 }
diff --git a/tests/src/core/testqgsexpression.cpp b/tests/src/core/testqgsexpression.cpp
@@ -1287,7 +1287,7 @@ class TestQgsExpression: public QObject
       QTest::newRow( "'a' not  like 'a%'" ) << QStringLiteral( "'a' not  like 'a%'" ) << false << QVariant( 0 );
 
       // with_variable
-      QTest::newRow( "with_variable('five', 5, @five * 2)" ) << QStringLiteral( "with_variable('five', 5, @five * 2)" ) << false << QVariant( 10 );
+      QTest::newRow( "with_variable(name:='five', value:=5, expression:=@five * 2)" ) << QStringLiteral( "with_variable(name:='five', value:=5, expression:=@five * 2)" ) << false << QVariant( 10 );
       QTest::newRow( "with_variable('nothing', NULL, COALESCE(@nothing, 'something'))" ) << QStringLiteral( "with_variable('nothing', NULL, COALESCE(@nothing, 'something'))" ) << false << QVariant( "something" );
 
       // array_first, array_last

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`"arguments": [`
`6`	`6`	`{"arg":"name","description":"the name of the variable to set"},`
`7`	`7`	`{"arg":"value","description":"the value to set"},`
`8`		`- {"arg":"node","description":"the expression for which the variable will be available"}`
	`8`	`+ {"arg":"expression","description":"the expression for which the variable will be available"}`
`9`	`9`	`],`
`10`	`10`	`"examples": [ { "expression":"with_variable('my_sum', 1 + 2 + 3, @my_sum * 2 + @my_sum * 5)", "returns":"42"}]`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4863,7 +4863,11 @@ bool QgsArrayForeachExpressionFunction::prepare( const QgsExpressionNodeFunction`
`4863`	`4863`	`}`
`4864`	`4864`
`4865`	`4865`	`QgsWithVariableExpressionFunction::QgsWithVariableExpressionFunction()`
`4866`		`- : QgsExpressionFunction( QStringLiteral( "with_variable" ), 3, QCoreApplication::tr( "General" ) )`
	`4866`	`+ : QgsExpressionFunction( QStringLiteral( "with_variable" ), QgsExpressionFunction::ParameterList() <<`
	`4867`	`+ QgsExpressionFunction::Parameter( QStringLiteral( "name" ) )`
	`4868`	`+ << QgsExpressionFunction::Parameter( QStringLiteral( "value" ) )`
	`4869`	`+ << QgsExpressionFunction::Parameter( QStringLiteral( "expression" ) ),`
	`4870`	`+ QCoreApplication::tr( "General" ) )`
`4867`	`4871`	`{`
`4868`	`4872`
`4869`	`4873`	`}`