Interface for temporary user creation config and name matching. More...
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 a configured pattern which indicates that it conflicts with temporary user names? Should manual user creation be denied? More... | |
| isTempName (string $name) | |
| Does the name match the configured pattern indicating that it is a temporary auto-created user? More... | |
| shouldAutoCreate (Authority $authority, string $action) | |
| Should/would auto-create be performed if the user attempts to perform the given action? 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 16 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 a configured pattern which indicates that it conflicts with temporary user names? Should manual user creation be denied?
- Parameters
-
string $name
- Returns
- mixed
Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.
◆ isTempName()
| MediaWiki\User\TempUser\TempUserConfig::isTempName | ( | 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.
◆ shouldAutoCreate()
| MediaWiki\User\TempUser\TempUserConfig::shouldAutoCreate | ( | Authority | $authority, |
| string | $action | ||
| ) |
Should/would auto-create be performed if the user attempts to perform the given action?
- Since
- 1.41
- Parameters
-
Authority $authority string $action
- Returns
- bool
Implemented in MediaWiki\User\TempUser\TempUserCreator, and MediaWiki\User\TempUser\RealTempUserConfig.
The documentation for this interface was generated from the following file:
- includes/user/TempUser/TempUserConfig.php
