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 | |
| bool | $assignKnownUsers = false |
| bool[] | $triedCreations = [] |
| string | $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 50 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
- Returns
- string Prefixed username, using ">" as separator
Definition at line 125 of file ExternalUserNames.php.
References $name.
Referenced by applyPrefix().
◆ applyPrefix()
| 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 95 of file ExternalUserNames.php.
References $name, addPrefix(), User\idFromName(), and User\isUsableName().
◆ getLocal()
|
static |
Get local part of the user name.
- Parameters
-
string $username Username to get
- Returns
- string
Definition at line 145 of file ExternalUserNames.php.
References $username.
Referenced by RCCacheEntryFactory\getUserLink(), and ExternalUserNamesTest\testGetLocal().
◆ getUserLinkTitle()
|
static |
Get a target Title to link a username.
- Parameters
-
string $userName Username to link
- Returns
- null|Title
Definition at line 62 of file ExternalUserNames.php.
References $title, NS_MAIN, and NS_USER.
Referenced by ExternalUserNamesTest\testGetUserLinkTitle(), and Linker\userLink().
◆ isExternal()
|
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 135 of file ExternalUserNames.php.
References $username.
Referenced by SpecialContributions\execute(), ApiQueryUserContribs\execute(), ExternalUserNamesTest\testIsExternal(), Linker\userLink(), Linker\userToolLinks(), and ApiBase\validateUser().
Member Data Documentation
◆ $assignKnownUsers
|
private |
Definition at line 39 of file ExternalUserNames.php.
Referenced by __construct().
◆ $triedCreations
|
private |
Definition at line 44 of file ExternalUserNames.php.
◆ $usernamePrefix
|
private |
Definition at line 34 of file ExternalUserNames.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
- includes/user/ExternalUserNames.php
