MediaWiki  master
MediaWiki\User\TempUser\RealTempUserConfig Class Reference

The real TempUserConfig including internal methods used by TempUserCreator. More...

Inheritance diagram for MediaWiki\User\TempUser\RealTempUserConfig:
Collaboration diagram for MediaWiki\User\TempUser\RealTempUserConfig:

Public Member Functions

 __construct ( $config)
 
 getGeneratorPattern ()
 
 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 the configured pattern indicating that it is a temporary auto-created user? More...
 

Private Attributes

string[] $autoCreateActions
 
bool $enabled = false
 
Pattern null $genPattern
 
Pattern null $matchPattern
 
array $serialMappingConfig = []
 
array $serialProviderConfig = []
 

Detailed Description

The real TempUserConfig including internal methods used by TempUserCreator.

Since
1.39

Definition at line 12 of file RealTempUserConfig.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\TempUser\RealTempUserConfig::__construct (   $config)
Parameters
array$configSee the documentation of $wgAutoCreateTempUser.
  • enabled: bool
  • actions: array
  • genPattern: string
  • matchPattern string, optional
  • serialProvider: array
  • serialMapping: array

Definition at line 40 of file RealTempUserConfig.php.

References MediaWiki\$config, and MediaWiki\User\TempUser\RealTempUserConfig\$genPattern.

Member Function Documentation

◆ getGeneratorPattern()

MediaWiki\User\TempUser\RealTempUserConfig::getGeneratorPattern ( )
Access: internal
For TempUserCreator only
Returns
Pattern

Definition at line 84 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 72 of file RealTempUserConfig.php.

◆ getSerialMappingConfig()

MediaWiki\User\TempUser\RealTempUserConfig::getSerialMappingConfig ( )
Access: internal
For TempUserCreator only
Returns
array

Definition at line 104 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 96 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 59 of file RealTempUserConfig.php.

References MediaWiki\$action.

◆ isEnabled()

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

Is temp user creation enabled?

Returns
bool

Implements MediaWiki\User\TempUser\TempUserConfig.

Definition at line 55 of file RealTempUserConfig.php.

References MediaWiki\User\TempUser\RealTempUserConfig\$enabled.

◆ isReservedName()

MediaWiki\User\TempUser\RealTempUserConfig::isReservedName ( 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 67 of file RealTempUserConfig.php.

Member Data Documentation

◆ $autoCreateActions

string [] MediaWiki\User\TempUser\RealTempUserConfig::$autoCreateActions
private

Definition at line 23 of file RealTempUserConfig.php.

◆ $enabled

bool MediaWiki\User\TempUser\RealTempUserConfig::$enabled = false
private

◆ $genPattern

Pattern null MediaWiki\User\TempUser\RealTempUserConfig::$genPattern
private

◆ $matchPattern

Pattern null MediaWiki\User\TempUser\RealTempUserConfig::$matchPattern
private

Definition at line 29 of file RealTempUserConfig.php.

◆ $serialMappingConfig

array MediaWiki\User\TempUser\RealTempUserConfig::$serialMappingConfig = []
private

Definition at line 20 of file RealTempUserConfig.php.

◆ $serialProviderConfig

array MediaWiki\User\TempUser\RealTempUserConfig::$serialProviderConfig = []
private

Definition at line 17 of file RealTempUserConfig.php.


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