MediaWiki  master
MediaWiki\User\TempUser\TempUserConfig Interface Reference

Interface for temporary user creation config and name matching. More...

Inheritance diagram for MediaWiki\User\TempUser\TempUserConfig:

Public Member Functions

 getPlaceholderName ()
 Get a placeholder name which matches the reserved prefix. More...
 
 isAutoCreateAction (string $action)
 Is the action valid for user auto-creation? More...
 
 isEnabled ()
 Is temp user creation enabled? More...
 
 isReservedName (string $name)
 Does the name match the configured pattern indicating that it is a temporary auto-created user? More...
 

Detailed Description

Interface for temporary user creation config and name matching.

This is separate from TempUserCreator to avoid dependency loops during service construction, since TempUserCreator needs UserNameUtils which needs TempUserConfig.

Since
1.39

Definition at line 14 of file TempUserConfig.php.

Member Function Documentation

◆ getPlaceholderName()

MediaWiki\User\TempUser\TempUserConfig::getPlaceholderName ( )

Get a placeholder name which matches the reserved prefix.

Returns
string

Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.

◆ isAutoCreateAction()

MediaWiki\User\TempUser\TempUserConfig::isAutoCreateAction ( string  $action)

Is the action valid for user auto-creation?

Parameters
string$action
Returns
bool

Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.

◆ isEnabled()

MediaWiki\User\TempUser\TempUserConfig::isEnabled ( )

Is temp user creation enabled?

Returns
bool

Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.

◆ isReservedName()

MediaWiki\User\TempUser\TempUserConfig::isReservedName ( string  $name)

Does the name match the configured pattern indicating that it is a temporary auto-created user?

Parameters
string$name
Returns
bool

Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.


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