MediaWiki master
|
Service for temporary user creation. More...
Inherits MediaWiki\User\TempUser\TempUserConfig.
Public Member Functions | |
__construct (RealTempUserConfig $config, ObjectFactory $objectFactory, UserFactory $userFactory, AuthManager $authManager, ?Throttler $throttler) | |
acquireAndStashName (Session $session) | |
Permanently acquire a username, stash it in a session, and return it. | |
create ( $name=null, WebRequest $request=null) | |
Acquire a serial number, create the corresponding user and log in. | |
getExpireAfterDays () | |
After how many days do temporary users expire? | |
getMatchPattern () | |
Get a Pattern indicating how temporary account can be detected. | |
getNotifyBeforeExpirationDays () | |
How many days before expiration should temporary users be notified? | |
getPlaceholderName () | |
Get a placeholder name which matches the reserved prefix. | |
getStashedName (Session $session) | |
Return a possible acquired and stashed username in a session. | |
isAutoCreateAction (string $action) | |
Is the action valid for user auto-creation? | |
isEnabled () | |
Is temp user creation enabled? | |
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? | |
isTempName (string $name) | |
Does the name match the configured pattern indicating that it is a temporary auto-created user? | |
shouldAutoCreate (Authority $authority, string $action) | |
Should/would auto-create be performed if the user attempts to perform the given action? | |
Service for temporary user creation.
For convenience this also proxies the TempUserConfig methods.
This is separate from TempUserConfig to avoid dependency loops. Special pages and actions are free to use this class, but services should take it as a constructor parameter only if necessary.
Definition at line 26 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::__construct | ( | RealTempUserConfig | $config, |
ObjectFactory | $objectFactory, | ||
UserFactory | $userFactory, | ||
AuthManager | $authManager, | ||
?Throttler | $throttler | ||
) |
Definition at line 62 of file TempUserCreator.php.
References MediaWiki\User\TempUser\RealTempUserConfig\getSerialMappingConfig(), and MediaWiki\User\TempUser\RealTempUserConfig\getSerialProviderConfig().
MediaWiki\User\TempUser\TempUserCreator::acquireAndStashName | ( | Session | $session | ) |
Permanently acquire a username, stash it in a session, and return it.
Do not create the user.
If this method was called before with the same session ID, return the previously stashed username instead of acquiring a new one.
Session | $session |
Definition at line 266 of file TempUserCreator.php.
References MediaWiki\Session\Session\get(), MediaWiki\Session\Session\save(), and MediaWiki\Session\Session\set().
MediaWiki\User\TempUser\TempUserCreator::create | ( | $name = null , |
|
WebRequest | $request = null |
||
) |
Acquire a serial number, create the corresponding user and log in.
string | null | $name | Previously acquired name |
WebRequest | null | $request | Request details, used for throttling |
Definition at line 85 of file TempUserCreator.php.
References StatusValue\fatal(), and wfMessage().
MediaWiki\User\TempUser\TempUserCreator::getExpireAfterDays | ( | ) |
After how many days do temporary users expire?
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 157 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::getMatchPattern | ( | ) |
Get a Pattern indicating how temporary account can be detected.
Used to avoid selecting a temp account via select queries.
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 153 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::getNotifyBeforeExpirationDays | ( | ) |
How many days before expiration should temporary users be notified?
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 161 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::getPlaceholderName | ( | ) |
Get a placeholder name which matches the reserved prefix.
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 149 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::getStashedName | ( | Session | $session | ) |
Return a possible acquired and stashed username in a session.
Do not acquire or create the user.
If this method is called with the same session ID as function acquireAndStashName(), it returns the previously stashed username.
Session | $session |
Definition at line 288 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::isAutoCreateAction | ( | string | $action | ) |
Is the action valid for user auto-creation?
string | $action |
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 133 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::isEnabled | ( | ) |
Is temp user creation enabled?
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 129 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::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?
string | $name |
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 145 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::isTempName | ( | string | $name | ) |
Does the name match the configured pattern indicating that it is a temporary auto-created user?
string | $name |
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 141 of file TempUserCreator.php.
MediaWiki\User\TempUser\TempUserCreator::shouldAutoCreate | ( | Authority | $authority, |
string | $action | ||
) |
Should/would auto-create be performed if the user attempts to perform the given action?
Authority | $authority | |
string | $action |
Implements MediaWiki\User\TempUser\TempUserConfig.
Definition at line 137 of file TempUserCreator.php.