This is a value object to hold authentication response data. More...

Collaboration diagram for MediaWiki\Auth\AuthenticationResponse:

[legend]

Static Public Member Functions
static	newAbstain ()

static	newFail (Message $msg)

static	newPass ( $username=null)

static	newRedirect (array $reqs, $redirectTarget, $redirectApiData=null)

static	newRestart (Message $msg)

static	newUI (array $reqs, Message $msg)

Public Attributes
AuthenticationRequest null	$createRequest = null
	Returned with a PrimaryAuthenticationProvider login FAIL or a PASS with no username, this holds a request that should result in a PASS when passed to that provider's PrimaryAuthenticationProvider::beginPrimaryAccountCreation().

AuthenticationRequest null	$linkRequest = null
	Returned with a PrimaryAuthenticationProvider login PASS with no username, this holds a request to pass to AuthManager::changeAuthenticationData() to link the account once the local user has been determined.

AuthenticationRequest null	$loginRequest = null
	Returned with an AuthManager account creation PASS, this holds a request to pass to AuthManager::beginAuthentication() to immediately log into the created account.

Message null	$message = null
	I18n message to display in case of UI or FAIL.

AuthenticationRequest[]	$neededRequests = []
	Needed AuthenticationRequests to continue after a UI or REDIRECT response.

mixed	$redirectApiData = null
	Data for a REDIRECT response that a client might use to query the remote site via its API rather than by following $redirectTarget.

string null	$redirectTarget = null
	URL to redirect to for a REDIRECT response.

string	$status
	One of the constants above.

string null	$username = null
	Local user name from authentication.

const	ABSTAIN = 'ABSTAIN'
	Indicates that the authentication provider does not handle this request.

const	FAIL = 'FAIL'
	Indicates that the authentication failed.

const	PASS = 'PASS'
	Indicates that the authentication succeeded.

const	REDIRECT = 'REDIRECT'
	Indicates that the authentication needs to be redirected to a third party to proceed.

const	RESTART = 'RESTART'
	Indicates that third-party authentication succeeded but no user exists.

const	UI = 'UI'
	Indicates that the authentication needs further user input of some sort.

Detailed Description

This is a value object to hold authentication response data.

Since: 1.27

Definition at line 33 of file AuthenticationResponse.php.

Member Function Documentation

◆ newAbstain()

static MediaWiki\Auth\AuthenticationResponse::newAbstain ( )

static

Returns: AuthenticationResponse

Definition at line 149 of file AuthenticationResponse.php.

References $ret, and MediaWiki\Auth\AuthenticationResponse\ABSTAIN.

◆ newFail()

static MediaWiki\Auth\AuthenticationResponse::newFail ( Message $msg )

static

Parameters

Message $msg

Returns: AuthenticationResponse

Definition at line 128 of file AuthenticationResponse.php.

References $ret, and MediaWiki\Auth\AuthenticationResponse\FAIL.

◆ newPass()

static MediaWiki\Auth\AuthenticationResponse::newPass ( $username = null )

static

Parameters

string | null $username Local username

Returns: AuthenticationResponse

Definition at line 117 of file AuthenticationResponse.php.

References $ret, MediaWiki\Auth\AuthenticationResponse\$username, and MediaWiki\Auth\AuthenticationResponse\PASS.

◆ newRedirect()

static MediaWiki\Auth\AuthenticationResponse::newRedirect	(	array	$reqs,
			$redirectTarget,
			$redirectApiData = `null`
	)

static

Parameters

AuthenticationRequest[]	$reqs	AuthenticationRequests needed to continue
string	$redirectTarget	URL
mixed	$redirectApiData	Data suitable for adding to an ApiResult

Returns: AuthenticationResponse

Definition at line 178 of file AuthenticationResponse.php.

References MediaWiki\Auth\AuthenticationResponse\$redirectApiData, MediaWiki\Auth\AuthenticationResponse\$redirectTarget, $ret, and MediaWiki\Auth\AuthenticationResponse\REDIRECT.

Referenced by MediaWiki\Auth\AuthManagerTest\provideAccountCreation(), MediaWiki\Auth\AuthManagerTest\provideAccountLink(), and MediaWiki\Auth\AuthManagerTest\provideAuthentication().

◆ newRestart()

static MediaWiki\Auth\AuthenticationResponse::newRestart ( Message $msg )

static

Parameters

Message $msg

Returns: AuthenticationResponse

Definition at line 139 of file AuthenticationResponse.php.

References $ret, and MediaWiki\Auth\AuthenticationResponse\RESTART.

Referenced by MediaWiki\Auth\AuthManager\continueAuthentication(), and MediaWiki\Auth\AuthManagerTest\provideAuthentication().

◆ newUI()

static MediaWiki\Auth\AuthenticationResponse::newUI	(	array	$reqs,
		Message	$msg
	)

static

Parameters

AuthenticationRequest[]	$reqs	AuthenticationRequests needed to continue
Message	$msg

Returns: AuthenticationResponse

Definition at line 160 of file AuthenticationResponse.php.

References $ret, and MediaWiki\Auth\AuthenticationResponse\UI.

Referenced by MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\beginLinkAttempt(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProvider\continueLinkAttempt(), MediaWiki\Auth\AuthManagerTest\provideAccountCreation(), MediaWiki\Auth\AuthManagerTest\provideAccountLink(), MediaWiki\Auth\AuthManagerTest\provideAuthentication(), MediaWiki\Auth\AuthManagerTest\testAutoCreateOnLogin(), MediaWiki\Auth\AuthManagerTest\testCreateFromLogin(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProvider\tryReset().

Member Data Documentation

◆ $createRequest

AuthenticationRequest null MediaWiki\Auth\AuthenticationResponse::$createRequest = null

Returned with a PrimaryAuthenticationProvider login FAIL or a PASS with no username, this holds a request that should result in a PASS when passed to that provider's PrimaryAuthenticationProvider::beginPrimaryAccountCreation().

Returned with an AuthManager login FAIL or RESTART, this holds a CreateFromLoginAuthenticationRequest that may be passed to AuthManager::beginCreateAccount(), possibly in place of any "primary-required" requests. It may also be passed to AuthManager::beginAuthentication() to preserve state.

Definition at line 96 of file AuthenticationResponse.php.

◆ $linkRequest

AuthenticationRequest null MediaWiki\Auth\AuthenticationResponse::$linkRequest = null

Returned with a PrimaryAuthenticationProvider login PASS with no username, this holds a request to pass to AuthManager::changeAuthenticationData() to link the account once the local user has been determined.

Definition at line 104 of file AuthenticationResponse.php.

◆ $loginRequest

AuthenticationRequest null MediaWiki\Auth\AuthenticationResponse::$loginRequest = null

Returned with an AuthManager account creation PASS, this holds a request to pass to AuthManager::beginAuthentication() to immediately log into the created account.

Definition at line 111 of file AuthenticationResponse.php.

◆ $message

Message null MediaWiki\Auth\AuthenticationResponse::$message = null

I18n message to display in case of UI or FAIL.

Definition at line 75 of file AuthenticationResponse.php.

◆ $neededRequests

AuthenticationRequest [] MediaWiki\Auth\AuthenticationResponse::$neededRequests = []

Needed AuthenticationRequests to continue after a UI or REDIRECT response.

Definition at line 72 of file AuthenticationResponse.php.

◆ $redirectApiData

mixed MediaWiki\Auth\AuthenticationResponse::$redirectApiData = null

Data for a REDIRECT response that a client might use to query the remote site via its API rather than by following $redirectTarget.

Value must be something acceptable to ApiResult::addValue().

Definition at line 66 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthenticationResponse\newRedirect().

◆ $redirectTarget

string null MediaWiki\Auth\AuthenticationResponse::$redirectTarget = null

URL to redirect to for a REDIRECT response.

Definition at line 59 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthenticationResponse\newRedirect().

◆ $status

string MediaWiki\Auth\AuthenticationResponse::$status

One of the constants above.

Definition at line 56 of file AuthenticationResponse.php.

◆ $username

string null MediaWiki\Auth\AuthenticationResponse::$username = null

Local user name from authentication.

May be null if the authentication passed but no local user is known.

Definition at line 81 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthenticationResponse\newPass().

◆ ABSTAIN

const MediaWiki\Auth\AuthenticationResponse::ABSTAIN = 'ABSTAIN'

Indicates that the authentication provider does not handle this request.

Definition at line 47 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAuthentication(), MediaWiki\Auth\AuthenticationResponse\newAbstain(), MediaWiki\Auth\AuthenticationResponseTest\provideConstructors(), and MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProviderTest\testFailResponse().

◆ FAIL

const MediaWiki\Auth\AuthenticationResponse::FAIL = 'FAIL'

Indicates that the authentication failed.

Definition at line 38 of file AuthenticationResponse.php.

◆ PASS

const MediaWiki\Auth\AuthenticationResponse::PASS = 'PASS'

Indicates that the authentication succeeded.

Definition at line 35 of file AuthenticationResponse.php.

◆ REDIRECT

const MediaWiki\Auth\AuthenticationResponse::REDIRECT = 'REDIRECT'

Indicates that the authentication needs to be redirected to a third party to proceed.

Definition at line 53 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), MediaWiki\Auth\AuthManager\continueAuthentication(), MediaWiki\Auth\AuthenticationResponse\newRedirect(), and MediaWiki\Auth\AuthenticationResponseTest\provideConstructors().

◆ RESTART

const MediaWiki\Auth\AuthenticationResponse::RESTART = 'RESTART'

Indicates that third-party authentication succeeded but no user exists.

Either treat this like a UI response or pass $this->createRequest to AuthManager::beginCreateAccount().

Definition at line 44 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthenticationResponse\newRestart(), MediaWiki\Auth\AuthenticationResponseTest\provideConstructors(), and MediaWiki\Auth\AuthManagerTest\testAuthentication().

◆ UI

const MediaWiki\Auth\AuthenticationResponse::UI = 'UI'

Indicates that the authentication needs further user input of some sort.

Definition at line 50 of file AuthenticationResponse.php.

Referenced by MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), MediaWiki\Auth\AuthManager\continueAuthentication(), MediaWiki\Auth\AuthenticationResponse\newUI(), MediaWiki\Auth\AuthenticationResponseTest\provideConstructors(), MediaWiki\Auth\AuthManagerTest\testAutoCreateOnLogin(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProviderTest\testBeginLinkAttempt(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProviderTest\testContinueLinkAttempt(), MediaWiki\Auth\AuthManagerTest\testCreateFromLogin(), and MediaWiki\Auth\ResetPasswordSecondaryAuthenticationProviderTest\testTryReset().

The documentation for this class was generated from the following file:

includes/auth/AuthenticationResponse.php

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ newAbstain()

◆ newFail()

◆ newPass()

◆ newRedirect()

◆ newRestart()

◆ newUI()

Member Data Documentation

◆ $createRequest

◆ $linkRequest

◆ $loginRequest

◆ $message

◆ $neededRequests

◆ $redirectApiData

◆ $redirectTarget

◆ $status

◆ $username

◆ ABSTAIN

◆ FAIL

◆ PASS

◆ REDIRECT

◆ RESTART

◆ UI