From: Brad Jorsch <bjorsch@wikimedia.org>
Date: Tue, 13 May 2014 15:27:53 +0000 (-0400)
Subject: API: Fix documentation for ApiBase::require*OneParameter
X-Git-Tag: 1.31.0-rc.0~15735^2
X-Git-Url: https://git.cyclocoop.org/%7B%7B%20url_for%28%27votes%27%2C%20votes=%27waiting%27%29%20%7D%7D?a=commitdiff_plain;h=b9fd30a4e41c1ccce4afdcdd4f0fe8dbc47bf5e8;p=lhc%2Fweb%2Fwiklou.git

API: Fix documentation for ApiBase::require*OneParameter

The existing doc blocks for all three of these functions is entirely
wrong.
* ApiBase::requireOnlyOneParameter
* ApiBase::requireMaxOneParameter
* ApiBase::requireAtLeastOneParameter

Change-Id: Id0dd86be3cbfa813a43f918c7d780c7ee2afc09e
---

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index e451f2a1b8..a1e02efe92 100644
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -720,9 +720,10 @@ abstract class ApiBase extends ContextSource {
 
 	/**
 	 * Die if none or more than one of a certain set of parameters is set and not false.
-	 * @param array $params Array of parameter names
+	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
+	 * @param string $required,... Names of parameters of which exactly one must be set
 	 */
-	public function requireOnlyOneParameter( $params ) {
+	public function requireOnlyOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
 		array_shift( $required );
 		$p = $this->getModulePrefix();
@@ -766,10 +767,10 @@ abstract class ApiBase extends ContextSource {
 
 	/**
 	 * Die if more than one of a certain set of parameters is set and not false.
-	 *
-	 * @param array $params
+	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
+	 * @param string $required,... Names of parameters of which at most one must be set
 	 */
-	public function requireMaxOneParameter( $params ) {
+	public function requireMaxOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
 		array_shift( $required );
 		$p = $this->getModulePrefix();
@@ -807,10 +808,10 @@ abstract class ApiBase extends ContextSource {
 	 * Die if none of a certain set of parameters is set and not false.
 	 *
 	 * @since 1.23
-	 * @param array $params User provided set of parameters
-	 * @param string ... List of parameter names to check
+	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
+	 * @param string $required,... Names of parameters of which at least one must be set
 	 */
-	public function requireAtLeastOneParameter( $params ) {
+	public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
 		array_shift( $required );
 		$p = $this->getModulePrefix();