The real TempUserConfig including internal methods used by TempUserCreator. More...
Public Member Functions | |
| __construct ( $config) | |
| getGeneratorPattern () | |
| getMatchPattern () | |
| Get a Pattern indicating how temporary account can be detected. More... | |
| getPlaceholderName () | |
| Get a placeholder name which matches the reserved prefix. More... | |
| getSerialMappingConfig () | |
| getSerialProviderConfig () | |
| 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
The real TempUserConfig including internal methods used by TempUserCreator.
- Since
- 1.39
Definition at line 13 of file RealTempUserConfig.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\User\TempUser\RealTempUserConfig::__construct | ( | $config | ) |
- Parameters
-
array $config See the documentation of $wgAutoCreateTempUser. - enabled: bool
- actions: array
- genPattern: string
- matchPattern: string, optional
- reservedPattern: string, optional
- serialProvider: array
- serialMapping: array
Definition at line 45 of file RealTempUserConfig.php.
Member Function Documentation
◆ getGeneratorPattern()
| MediaWiki\User\TempUser\RealTempUserConfig::getGeneratorPattern | ( | ) |
- Access: internal
- For TempUserCreator only
- Returns
- Pattern
Definition at line 111 of file RealTempUserConfig.php.
◆ getMatchPattern()
| MediaWiki\User\TempUser\RealTempUserConfig::getMatchPattern | ( | ) |
Get a Pattern indicating how temporary account can be detected.
Used to avoid selecting a temp account via select queries.
- Returns
- Pattern
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 99 of file RealTempUserConfig.php.
◆ getPlaceholderName()
| MediaWiki\User\TempUser\RealTempUserConfig::getPlaceholderName | ( | ) |
Get a placeholder name which matches the reserved prefix.
- Returns
- string
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 91 of file RealTempUserConfig.php.
◆ getSerialMappingConfig()
| MediaWiki\User\TempUser\RealTempUserConfig::getSerialMappingConfig | ( | ) |
- Access: internal
- For TempUserCreator only
- Returns
- array
Definition at line 131 of file RealTempUserConfig.php.
Referenced by MediaWiki\User\TempUser\TempUserCreator\__construct().
◆ getSerialProviderConfig()
| MediaWiki\User\TempUser\RealTempUserConfig::getSerialProviderConfig | ( | ) |
- Access: internal
- For TempUserCreator only
- Returns
- array
Definition at line 123 of file RealTempUserConfig.php.
Referenced by MediaWiki\User\TempUser\TempUserCreator\__construct().
◆ isAutoCreateAction()
| MediaWiki\User\TempUser\RealTempUserConfig::isAutoCreateAction | ( | string | $action | ) |
Is the action valid for user auto-creation?
- Parameters
-
string $action
- Returns
- bool
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 67 of file RealTempUserConfig.php.
Referenced by MediaWiki\User\TempUser\RealTempUserConfig\shouldAutoCreate().
◆ isEnabled()
| MediaWiki\User\TempUser\RealTempUserConfig::isEnabled | ( | ) |
Is temp user creation enabled?
- Returns
- bool
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 63 of file RealTempUserConfig.php.
◆ isReservedName()
| MediaWiki\User\TempUser\RealTempUserConfig::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
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 86 of file RealTempUserConfig.php.
◆ isTempName()
| MediaWiki\User\TempUser\RealTempUserConfig::isTempName | ( | string | $name | ) |
Does the name match the configured pattern indicating that it is a temporary auto-created user?
- Parameters
-
string $name
- Returns
- bool
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 81 of file RealTempUserConfig.php.
◆ shouldAutoCreate()
| MediaWiki\User\TempUser\RealTempUserConfig::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
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 75 of file RealTempUserConfig.php.
References MediaWiki\Permissions\Authority\isAllowed(), MediaWiki\User\TempUser\RealTempUserConfig\isAutoCreateAction(), and MediaWiki\Permissions\Authority\isRegistered().
The documentation for this class was generated from the following file:
- includes/user/TempUser/RealTempUserConfig.php
