MediaWiki\User\ExternalUserNames Class Reference

Class to parse and build external user names. More...

Public Member Functions
	__construct ( $usernamePrefix, $assignKnownUsers)
	addPrefix ( $name)
	Add an interwiki prefix to the username regardless of circumstances.
	applyPrefix ( $name)
	Add an interwiki prefix to the username, if appropriate.

Static Public Member Functions
static	getLocal ( $username)
	Get local part of the user name.
static	getUserLinkTitle ( $userName)
	Get a target Title to link a username.
static	isExternal ( $username)
	Tells whether the username is external or not.

Detailed Description

Class to parse and build external user names.

Since

1.31

Definition at line 35 of file ExternalUserNames.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\User\ExternalUserNames::__construct	(		$usernamePrefix,
			$assignKnownUsers )

Parameters

string	$usernamePrefix	Prefix to apply to unknown (and possibly also known) usernames
bool	$assignKnownUsers	Whether to apply the prefix to usernames that exist locally

Definition at line 49 of file ExternalUserNames.php.

Member Function Documentation

addPrefix()

MediaWiki\User\ExternalUserNames::addPrefix

(

$name

)

Add an interwiki prefix to the username regardless of circumstances.

Parameters

string

$name

Returns

string Prefixed username, using ">" as separator

Definition at line 141 of file ExternalUserNames.php.

Referenced by MediaWiki\User\ExternalUserNames\applyPrefix().

applyPrefix()

MediaWiki\User\ExternalUserNames::applyPrefix

(

$name

)

Add an interwiki prefix to the username, if appropriate.

This method does have a side-effect on SUL (single user login) wikis: Calling this calls the ImportHandleUnknownUser hook from the CentralAuth extension, which assigns a local ID to the global user name, if possible. No prefix is applied if this is successful.

See also

https://meta.wikimedia.org/wiki/Help:Unified_login

https://www.mediawiki.org/wiki/Manual:Hooks/ImportHandleUnknownUser

Parameters

string

$name

Returns

string Either the unchanged username if it's a known local user (or not a valid username), otherwise the name with the prefix prepended.

Definition at line 106 of file ExternalUserNames.php.

References MediaWiki\User\ExternalUserNames\addPrefix(), and MediaWiki\MediaWikiServices\getInstance().

getLocal()

static MediaWiki\User\ExternalUserNames::getLocal ( $username )

static

Get local part of the user name.

Parameters

string

$username

Username to get

Returns

string

Definition at line 161 of file ExternalUserNames.php.

getUserLinkTitle()

static MediaWiki\User\ExternalUserNames::getUserLinkTitle ( $userName )

static

Get a target Title to link a username.

Parameters

string

$userName

Username to link

Returns

null|Title

Definition at line 61 of file ExternalUserNames.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), NS_MAIN, and NS_USER.

isExternal()

static MediaWiki\User\ExternalUserNames::isExternal ( $username )

static

Tells whether the username is external or not.

Parameters

string

$username

Username to check

Returns

bool true if it's external, false otherwise.

Definition at line 151 of file ExternalUserNames.php.

---

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

• includes/user/ExternalUserNames.php