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.

Private Attributes
	$assignKnownUsers = false
	$triedCreations = []
	$usernamePrefix = 'imported'

Detailed Description

Class to parse and build external user names.

Since

1.31

Definition at line 29 of file ExternalUserNames.php.

Constructor & Destructor Documentation

__construct()

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 38 of file ExternalUserNames.php.

References $assignKnownUsers, and $usernamePrefix.

Member Function Documentation

addPrefix()

ExternalUserNames::addPrefix

(

$name

)

Add an interwiki prefix to the username regardless of circumstances.

Parameters

string

$name

Name being imported

Returns

string Name

Definition at line 105 of file ExternalUserNames.php.

References $name.

Referenced by applyPrefix().

applyPrefix()

ExternalUserNames::applyPrefix

(

$name

)

Add an interwiki prefix to the username, if appropriate.

Parameters

string

$name

Name being imported

Returns

string Name, possibly with the prefix prepended.

Definition at line 75 of file ExternalUserNames.php.

References $name, addPrefix(), User\idFromName(), and User\isUsableName().

getLocal()

static ExternalUserNames::getLocal (   $username )

static

Get local part of the user name.

Parameters

string

$username

Username to get

Returns

string

Definition at line 125 of file ExternalUserNames.php.

References $username.

Referenced by ExternalUserNamesTest\testGetLocal().

getUserLinkTitle()

static ExternalUserNames::getUserLinkTitle (   $userName )

static

Get a target Title to link a username.

Parameters

string

$userName

Username to link

Returns

null|Title

Definition at line 50 of file ExternalUserNames.php.

References $title, NS_MAIN, and NS_USER.

Referenced by ExternalUserNamesTest\testGetUserLinkTitle(), and Linker\userLink().

isExternal()

static 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 115 of file ExternalUserNames.php.

References $username.

Referenced by SpecialContributions\execute(), ApiQueryContributions\execute(), ExternalUserNamesTest\testIsExternal(), Linker\userLink(), Linker\userToolLinks(), and ApiBase\validateUser().

Member Data Documentation

$assignKnownUsers

ExternalUserNames::$assignKnownUsers = false

private

Definition at line 31 of file ExternalUserNames.php.

Referenced by __construct().

$triedCreations

ExternalUserNames::$triedCreations = []

private

Definition at line 32 of file ExternalUserNames.php.

$usernamePrefix

ExternalUserNames::$usernamePrefix = 'imported'

private

Definition at line 30 of file ExternalUserNames.php.

Referenced by __construct().

---

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

• includes/user/ExternalUserNames.php