MediaWiki REL1_35
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
MediaWiki\Preferences\SignatureValidator Class Reference
Collaboration diagram for MediaWiki\Preferences\SignatureValidator:
Collaboration graph
[legend]

Public Member Functions

 __construct (User $user, ?MessageLocalizer $localizer, ParserOptions $popts)
 
 validateSignature (string $signature)
 

Protected Member Functions

 applyPreSaveTransform (string $signature)
 
 checkLintErrors (string $signature)
 
 checkUserLinks (string $signature)
 

Private Member Functions

 getLintErrorDetails (array $lintError)
 
 getLintErrorLocation (array $lintError)
 

Private Attributes

MessageLocalizer null $localizer
 
ParserOptions $popts
 
User $user
 

Detailed Description

Since
1.35

Definition at line 37 of file SignatureValidator.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Preferences\SignatureValidator::__construct ( User  $user,
?MessageLocalizer  $localizer,
ParserOptions  $popts 
)

Definition at line 46 of file SignatureValidator.php.

References MediaWiki\Preferences\SignatureValidator\$localizer, MediaWiki\Preferences\SignatureValidator\$popts, and MediaWiki\Preferences\SignatureValidator\$user.

Member Function Documentation

◆ applyPreSaveTransform()

MediaWiki\Preferences\SignatureValidator::applyPreSaveTransform ( string  $signature)
protected
Parameters
string$signature
Returns
string|bool Signature with PST applied, or false if applying PST yields wikitext that would change if PST was applied again

Definition at line 156 of file SignatureValidator.php.

References MediaWiki\MediaWikiServices\getInstance(), and SpecialPage\getTitleFor().

Referenced by MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ checkLintErrors()

MediaWiki\Preferences\SignatureValidator::checkLintErrors ( string  $signature)
protected
Parameters
string$signature
Returns
array Array of error objects returned by Parsoid's lint API (empty array for no errors)

Definition at line 190 of file SignatureValidator.php.

References MW_VERSION.

Referenced by MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ checkUserLinks()

MediaWiki\Preferences\SignatureValidator::checkUserLinks ( string  $signature)
protected
Parameters
string$signature
Returns
bool Whether signature contains required links

Definition at line 240 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ getLintErrorDetails()

MediaWiki\Preferences\SignatureValidator::getLintErrorDetails ( array  $lintError)
private

Definition at line 284 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ getLintErrorLocation()

MediaWiki\Preferences\SignatureValidator::getLintErrorLocation ( array  $lintError)
private

Definition at line 279 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\validateSignature().

◆ validateSignature()

MediaWiki\Preferences\SignatureValidator::validateSignature ( string  $signature)
Parameters
string$signature
Returns
string[]|bool If localizer is defined: List of errors, as HTML (empty array for no errors) If localizer is not defined: True if there are errors, false if there are no errors

Definition at line 57 of file SignatureValidator.php.

References MediaWiki\Preferences\SignatureValidator\applyPreSaveTransform(), MediaWiki\Preferences\SignatureValidator\checkLintErrors(), MediaWiki\Preferences\SignatureValidator\checkUserLinks(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Preferences\SignatureValidator\getLintErrorDetails(), MediaWiki\Preferences\SignatureValidator\getLintErrorLocation(), and wfEscapeWikiText().

Member Data Documentation

◆ $localizer

MessageLocalizer null MediaWiki\Preferences\SignatureValidator::$localizer
private

Definition at line 42 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\__construct().

◆ $popts

ParserOptions MediaWiki\Preferences\SignatureValidator::$popts
private

Definition at line 44 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\__construct().

◆ $user

User MediaWiki\Preferences\SignatureValidator::$user
private

Definition at line 40 of file SignatureValidator.php.

Referenced by MediaWiki\Preferences\SignatureValidator\__construct().

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