Object holding data about a session's user. More...

Collaboration diagram for MediaWiki\Session\UserInfo:

[legend]

Public Member Functions
	__toString ()

	getId ()
	Return the user ID.

	getName ()
	Return the user name.

	getToken ()
	Return the user token.

	getUser ()
	Return a User object.

	isAnon ()
	Return whether this is an anonymous user.

	isVerified ()
	Return whether this represents a verified user.

	verified ()
	Return a verified version of this object.

Static Public Member Functions
static	newAnonymous ()
	Create an instance for an anonymous (i.e.

static	newFromId ( $id, $verified=false)
	Create an instance for a logged-in user by ID.

static	newFromName ( $name, $verified=false)
	Create an instance for a logged-in user by name.

static	newFromUser (User $user, $verified=false)
	Create an instance from an existing User object.

Private Member Functions
	__construct (?User $user, $verified)

Private Attributes
User null	$user = null

bool	$verified = false

Detailed Description

Object holding data about a session's user.

In general, this class exists for two purposes:

User doesn't distinguish between "anonymous user" and "non-anonymous user that doesn't exist locally", while we do need to.
We also need the "verified" property described below; tracking it via another data item to SessionInfo's constructor makes things much more confusing.

A UserInfo may be "verified". This indicates that the creator knows that the request really comes from that user, whether that's by validating OAuth credentials, SSL client certificates, or by having both the user ID and token available from cookies.

An "unverified" UserInfo should be used when it's not possible to authenticate the user, e.g. the user ID cookie is set but the user Token cookie isn't. If the Token is available but doesn't match, don't return a UserInfo at all.

Since: 1.27

Definition at line 53 of file UserInfo.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\UserInfo::__construct	(	?User	$user,
			$verified
	)

private

Definition at line 60 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$user, MediaWiki\Session\UserInfo\$verified, MediaWiki\MediaWikiServices\getInstance(), User\getName(), User\isAnon(), and MediaWiki\Session\UserInfo\verified().

Member Function Documentation

◆ __toString()

MediaWiki\Session\UserInfo::__toString ( )

Definition at line 184 of file UserInfo.php.

References MediaWiki\Session\UserInfo\getId(), MediaWiki\Session\UserInfo\getName(), and MediaWiki\Session\UserInfo\verified().

◆ getId()

MediaWiki\Session\UserInfo::getId ( )

Return the user ID.

Note: Do not use this to test for anonymous users!

Returns: int

Definition at line 148 of file UserInfo.php.

Referenced by MediaWiki\Session\UserInfo\__toString().

◆ getName()

MediaWiki\Session\UserInfo::getName ( )

Return the user name.

Returns: string|null

Definition at line 156 of file UserInfo.php.

Referenced by MediaWiki\Session\UserInfo\__toString().

◆ getToken()

MediaWiki\Session\UserInfo::getToken ( )

Return the user token.

Returns: string

Definition at line 164 of file UserInfo.php.

◆ getUser()

MediaWiki\Session\UserInfo::getUser ( )

Return a User object.

Returns: User

Definition at line 172 of file UserInfo.php.

◆ isAnon()

MediaWiki\Session\UserInfo::isAnon ( )

Return whether this is an anonymous user.

Returns: bool

Definition at line 131 of file UserInfo.php.

◆ isVerified()

MediaWiki\Session\UserInfo::isVerified ( )

Return whether this represents a verified user.

Returns: bool

Definition at line 139 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$verified.

◆ newAnonymous()

static MediaWiki\Session\UserInfo::newAnonymous ( )

static

Create an instance for an anonymous (i.e.

not logged in) user

Logged-out users are always "verified".

Returns: UserInfo

Definition at line 78 of file UserInfo.php.

References true.

Referenced by MediaWiki\Session\SessionManager\loadSessionInfoFromStore(), and MediaWiki\Session\CookieSessionProvider\provideSessionInfo().

◆ newFromId()

static MediaWiki\Session\UserInfo::newFromId	(	$id,
		$verified = `false`
	)

static

Create an instance for a logged-in user by ID.

Parameters

int	$id	User ID
bool	$verified	True if the user is verified

Returns: UserInfo

Definition at line 88 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$user, MediaWiki\Session\UserInfo\$verified, MediaWiki\MediaWikiServices\getInstance(), User\isAnon(), User\load(), and User\newFromId().

Referenced by MediaWiki\Session\SessionManager\loadSessionInfoFromStore(), and MediaWiki\Session\CookieSessionProvider\provideSessionInfo().

◆ newFromName()

static MediaWiki\Session\UserInfo::newFromName	(	$name,
		$verified = `false`
	)

static

Create an instance for a logged-in user by name.

Parameters

string	$name	User name (need not exist locally)
bool	$verified	True if the user is verified

Returns: UserInfo

Definition at line 106 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$user, MediaWiki\Session\UserInfo\$verified, MediaWiki\MediaWikiServices\getInstance(), and User\newFromName().

Referenced by MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

◆ newFromUser()

static MediaWiki\Session\UserInfo::newFromUser	(	User	$user,
			$verified = `false`
	)

static

Create an instance from an existing User object.

Parameters

User	$user	(need not exist locally)
bool	$verified	True if the user is verified

Returns: UserInfo

Definition at line 123 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$user, and MediaWiki\Session\UserInfo\$verified.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ verified()

MediaWiki\Session\UserInfo::verified ( )

Return a verified version of this object.

Returns: UserInfo

Definition at line 180 of file UserInfo.php.

References MediaWiki\Session\UserInfo\$user, true, and MediaWiki\Session\UserInfo\verified().

Referenced by MediaWiki\Session\UserInfo\__construct(), MediaWiki\Session\UserInfo\__toString(), and MediaWiki\Session\UserInfo\verified().

Member Data Documentation

◆ $user

User null MediaWiki\Session\UserInfo::$user = null

private

Definition at line 58 of file UserInfo.php.

Referenced by MediaWiki\Session\UserInfo\__construct(), MediaWiki\Session\UserInfo\newFromId(), MediaWiki\Session\UserInfo\newFromName(), MediaWiki\Session\UserInfo\newFromUser(), and MediaWiki\Session\UserInfo\verified().

◆ $verified

bool MediaWiki\Session\UserInfo::$verified = false

private

Definition at line 55 of file UserInfo.php.

Referenced by MediaWiki\Session\UserInfo\__construct(), MediaWiki\Session\UserInfo\isVerified(), MediaWiki\Session\UserInfo\newFromId(), MediaWiki\Session\UserInfo\newFromName(), and MediaWiki\Session\UserInfo\newFromUser().

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

includes/session/UserInfo.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ getId()

◆ getName()

◆ getToken()

◆ getUser()

◆ isAnon()

◆ isVerified()

◆ newAnonymous()

◆ newFromId()

◆ newFromName()

◆ newFromUser()

◆ verified()

Member Data Documentation

◆ $user

◆ $verified