UserNameUtils service. More...

Inheritance diagram for MediaWiki\User\UserNameUtils:

Collaboration diagram for MediaWiki\User\UserNameUtils:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, Language $contentLang, LoggerInterface $logger, TitleParser $titleParser, ITextFormatter $textFormatter, HookContainer $hookContainer)

	getCanonical (string $name, string $validate=self::RIGOR_VALID)
	Given unvalidated user input, return a canonical username, or false if the username is invalid.

	isCreatable (string $name)
	Usernames which fail to pass this function will be blocked from new account registrations, but may be used internally either by batch processes or by user accounts which have already been created.

	isIP (string $name)
	Does the string match an anonymous IP address?

	isUsable (string $name)
	Usernames which fail to pass this function will be blocked from user login and new account registrations, but may be used internally by batch processes.

	isValid (string $name)
	Is the input a valid username?

	isValidIPRange (string $range)
	Wrapper for IPUtils::isValidRange.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Private Attributes
Language	$contentLang

HookRunner	$hookRunner

LoggerInterface	$logger

ServiceOptions	$options
	RIGOR_* constants are inherited from UserRigorOptions.

string[] false	$reservedUsernames = false
	Cache for isUsable()

ITextFormatter	$textFormatter

TitleParser	$titleParser

Detailed Description

UserNameUtils service.

Since: 1.35

Definition at line 42 of file UserNameUtils.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\UserNameUtils::__construct	(	ServiceOptions	$options,
		Language	$contentLang,
		LoggerInterface	$logger,
		TitleParser	$titleParser,
		ITextFormatter	$textFormatter,
		HookContainer	$hookContainer
	)

Parameters

ServiceOptions	$options
Language	$contentLang
LoggerInterface	$logger
TitleParser	$titleParser
ITextFormatter	$textFormatter	the text formatter for the current content language
HookContainer	$hookContainer

Definition at line 100 of file UserNameUtils.php.

References MediaWiki\User\UserNameUtils\$contentLang, MediaWiki\User\UserNameUtils\$logger, MediaWiki\User\UserNameUtils\$options, MediaWiki\User\UserNameUtils\$textFormatter, MediaWiki\User\UserNameUtils\$titleParser, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getCanonical()

MediaWiki\User\UserNameUtils::getCanonical	(	string	$name,
		string	$validate = `self::RIGOR_VALID`
	)

Given unvalidated user input, return a canonical username, or false if the username is invalid.

Parameters

string	$name	User input
string	$validate	Type of validation to use Use of public constants RIGOR_* is preferred RIGOR_NONE No validation RIGOR_VALID Valid for batch processes RIGOR_USABLE Valid for batch processes and login RIGOR_CREATABLE Valid for batch processes, login and account creation

Exceptions

InvalidArgumentException

Returns: bool|string

Definition at line 258 of file UserNameUtils.php.

References $title, and NS_USER.

◆ isCreatable()

MediaWiki\User\UserNameUtils::isCreatable ( string $name )

Usernames which fail to pass this function will be blocked from new account registrations, but may be used internally either by batch processes or by user accounts which have already been created.

Additional preventions may be added here rather than in isValidUserName() to avoid disrupting existing accounts.

Parameters

string $name String to match

Returns: bool

Definition at line 219 of file UserNameUtils.php.

◆ isIP()

MediaWiki\User\UserNameUtils::isIP ( string $name )

Does the string match an anonymous IP address?

This function exists for username validation, in order to reject usernames which are similar in form to IP addresses. Strings such as 300.300.300.300 will return true because it looks like an IP address, despite not being strictly valid.

We match "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.xxx" as an anonymous IP address because the usemod software would "cloak" anonymous IP addresses like this, if we allowed accounts like this to be created new users could get the old edits of these anonymous users.

Unlike User::isIP, this does //not// match IPv6 ranges (T239527)

Parameters

string $name Name to check

Returns: bool

Definition at line 337 of file UserNameUtils.php.

Referenced by ImageListPager\__construct().

◆ isUsable()

MediaWiki\User\UserNameUtils::isUsable ( string $name )

Usernames which fail to pass this function will be blocked from user login and new account registrations, but may be used internally by batch processes.

If an account already exists in this form, login will be blocked by a failure to pass this function.

Parameters

string $name Name to match

Returns: bool

Definition at line 181 of file UserNameUtils.php.

◆ isValid()

MediaWiki\User\UserNameUtils::isValid ( string $name )

Is the input a valid username?

Checks if the input is a valid username, we don't want an empty string, an IP address, anything that contains slashes (would mess up subpages), is longer than the maximum allowed username size or doesn't begin with a capital letter.

Parameters

string $name Name to match

Returns: bool

Definition at line 128 of file UserNameUtils.php.

◆ isValidIPRange()

MediaWiki\User\UserNameUtils::isValidIPRange ( string $range )

Wrapper for IPUtils::isValidRange.

Parameters

string $range Range to check

Returns: bool

Definition at line 349 of file UserNameUtils.php.

Member Data Documentation

◆ $contentLang

Language MediaWiki\User\UserNameUtils::$contentLang

private

Definition at line 65 of file UserNameUtils.php.

Referenced by MediaWiki\User\UserNameUtils\__construct().

◆ $hookRunner

HookRunner MediaWiki\User\UserNameUtils::$hookRunner

private

Definition at line 90 of file UserNameUtils.php.

◆ $logger

LoggerInterface MediaWiki\User\UserNameUtils::$logger

private

Definition at line 70 of file UserNameUtils.php.

Referenced by MediaWiki\User\UserNameUtils\__construct().

◆ $options

ServiceOptions MediaWiki\User\UserNameUtils::$options

private

RIGOR_* constants are inherited from UserRigorOptions.

Definition at line 60 of file UserNameUtils.php.

Referenced by MediaWiki\User\UserNameUtils\__construct().

◆ $reservedUsernames

string [] false MediaWiki\User\UserNameUtils::$reservedUsernames = false

private

Cache for isUsable()

Definition at line 85 of file UserNameUtils.php.

◆ $textFormatter

ITextFormatter MediaWiki\User\UserNameUtils::$textFormatter

private

Definition at line 80 of file UserNameUtils.php.

Referenced by MediaWiki\User\UserNameUtils\__construct().

◆ $titleParser

TitleParser MediaWiki\User\UserNameUtils::$titleParser

private

Definition at line 75 of file UserNameUtils.php.

Referenced by MediaWiki\User\UserNameUtils\__construct().

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\UserNameUtils::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'MaxNameChars',
        'ReservedUsernames',
        'InvalidUsernameCharacters'
    ]

Access: internal: For use by ServiceWiring

Definition at line 47 of file UserNameUtils.php.

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

includes/user/UserNameUtils.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCanonical()

◆ isCreatable()

◆ isIP()

◆ isUsable()

◆ isValid()

◆ isValidIPRange()

Member Data Documentation

◆ $contentLang

◆ $hookRunner

◆ $logger

◆ $options

◆ $reservedUsernames

◆ $textFormatter

◆ $titleParser

◆ CONSTRUCTOR_OPTIONS