From b9fd30a4e41c1ccce4afdcdd4f0fe8dbc47bf5e8 Mon Sep 17 00:00:00 2001 From: Brad Jorsch Date: Tue, 13 May 2014 11:27:53 -0400 Subject: [PATCH] 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 --- includes/api/ApiBase.php | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) 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(); -- 2.20.1