From 3b2a5a7c776a2bb16ff873cb862914f8fbdc1bb5 Mon Sep 17 00:00:00 2001 From: Max Semenik Date: Mon, 26 Sep 2016 13:59:41 -0700 Subject: [PATCH] AuthManager phpdoc cleanup Change-Id: Ib6fa897e76ae479de68acaeb16708c2bdf15ae5f --- includes/auth/ButtonAuthenticationRequest.php | 2 ++ includes/auth/PasswordDomainAuthenticationRequest.php | 2 ++ .../auth/ResetPasswordSecondaryAuthenticationProvider.php | 1 + includes/specialpage/AuthManagerSpecialPage.php | 4 +++- 4 files changed, 8 insertions(+), 1 deletion(-) diff --git a/includes/auth/ButtonAuthenticationRequest.php b/includes/auth/ButtonAuthenticationRequest.php index 055d7ea49f..d274e18f7b 100644 --- a/includes/auth/ButtonAuthenticationRequest.php +++ b/includes/auth/ButtonAuthenticationRequest.php @@ -81,6 +81,8 @@ class ButtonAuthenticationRequest extends AuthenticationRequest { /** * @codeCoverageIgnore + * @param array $data + * @return AuthenticationRequest|static */ public static function __set_state( $data ) { if ( !isset( $data['label'] ) ) { diff --git a/includes/auth/PasswordDomainAuthenticationRequest.php b/includes/auth/PasswordDomainAuthenticationRequest.php index ddad54b252..3db7e212f8 100644 --- a/includes/auth/PasswordDomainAuthenticationRequest.php +++ b/includes/auth/PasswordDomainAuthenticationRequest.php @@ -70,6 +70,8 @@ class PasswordDomainAuthenticationRequest extends PasswordAuthenticationRequest /** * @codeCoverageIgnore + * @param array $data + * @return AuthenticationRequest|static */ public static function __set_state( $data ) { $ret = new static( $data['domainList'] ); diff --git a/includes/auth/ResetPasswordSecondaryAuthenticationProvider.php b/includes/auth/ResetPasswordSecondaryAuthenticationProvider.php index f11a12c421..45ac3aa0b5 100644 --- a/includes/auth/ResetPasswordSecondaryAuthenticationProvider.php +++ b/includes/auth/ResetPasswordSecondaryAuthenticationProvider.php @@ -58,6 +58,7 @@ class ResetPasswordSecondaryAuthenticationProvider extends AbstractSecondaryAuth /** * Try to reset the password + * @param \User $user * @param AuthenticationRequest[] $reqs * @return AuthenticationResponse */ diff --git a/includes/specialpage/AuthManagerSpecialPage.php b/includes/specialpage/AuthManagerSpecialPage.php index 3adf5a6fa2..bdf76384c8 100644 --- a/includes/specialpage/AuthManagerSpecialPage.php +++ b/includes/specialpage/AuthManagerSpecialPage.php @@ -43,7 +43,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage { * Change the form descriptor that determines how a field will look in the authentication form. * Called from fieldInfoToFormDescriptor(). * @param AuthenticationRequest[] $requests - * @param string $fieldInfo Field information array (union of all + * @param array $fieldInfo Field information array (union of all * AuthenticationRequest::getFieldInfo() responses). * @param array $formDescriptor HTMLForm descriptor. The special key 'weight' can be set to * change the order of the fields. @@ -205,6 +205,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage { /** * Return custom message key. * Allows subclasses to customize messages. + * @param string $defaultKey * @return string */ protected function messageKey( $defaultKey ) { @@ -668,6 +669,7 @@ abstract class AuthManagerSpecialPage extends SpecialPage { * Maps an authentication field configuration for a single field (as returned by * AuthenticationRequest::getFieldInfo()) to a HTMLForm field descriptor. * @param array $singleFieldInfo + * @param string $fieldName * @return array */ protected static function mapSingleFieldInfo( $singleFieldInfo, $fieldName ) { -- 2.20.1