MediaWiki  1.34.0
Static Public Member Functions | Static Private Attributes | List of all members
MWTidy Class Reference
Parser

Class to interact with and configure Remex tidy. More...

Static Public Member Functions

static destroySingleton ()
 Destroy the current singleton instance. More...
 
static factory (array $config=null)
 Create a new Tidy driver object from configuration. More...
 
static isEnabled ()
 
static setInstance ( $instance)
 Set the driver to be used. More...
 
static singleton ()
 
static tidy ( $text)
 Interface with Remex tidy. More...
 

Static Private Attributes

static $instance
 

Detailed Description

Class to interact with and configure Remex tidy.

Definition at line 29 of file MWTidy.php.

Member Function Documentation

◆ destroySingleton()

static MWTidy::destroySingleton ( )
static

Destroy the current singleton instance.

Definition at line 93 of file MWTidy.php.

◆ factory()

static MWTidy::factory ( array  $config = null)
static

Create a new Tidy driver object from configuration.

See also
$wgTidyConfig
Parameters
array | null$configOptional since 1.33
Returns
bool|\MediaWiki\Tidy\TidyDriverBase
Exceptions
MWException

Definition at line 76 of file MWTidy.php.

Referenced by BenchmarkTidy\execute(), and singleton().

◆ isEnabled()

static MWTidy::isEnabled ( )
static
Returns
bool

Definition at line 54 of file MWTidy.php.

References singleton().

Referenced by CompareParsers\checkOptions(), SpecialExpandTemplates\execute(), and TextExtracts\ApiQueryExtracts\truncate().

◆ setInstance()

static MWTidy::setInstance (   $instance)
static

Set the driver to be used.

This is for testing.

Parameters
MediaWiki\\Tidy\\TidyDriverBase | false | null$instance
Deprecated:
Since 1.33

Definition at line 85 of file MWTidy.php.

References $instance, and wfDeprecated().

◆ singleton()

static MWTidy::singleton ( )
static
Returns
bool|\MediaWiki\Tidy\TidyDriverBase

Definition at line 61 of file MWTidy.php.

References $instance, $wgTidyConfig, and factory().

Referenced by BenchmarkTidy\execute(), isEnabled(), tidy(), and TextExtracts\ApiQueryExtracts\truncate().

◆ tidy()

static MWTidy::tidy (   $text)
static

Interface with Remex tidy.

If tidy isn't able to correct the markup, the original will be returned in all its glory with a warning comment appended.

Parameters
string$textHTML input fragment. This should not contain a <body> or <html> tag.
Returns
string Corrected HTML output
Exceptions
MWException

Definition at line 42 of file MWTidy.php.

References singleton().

Referenced by SpecialExpandTemplates\execute().

Member Data Documentation

◆ $instance

MWTidy::$instance
staticprivate

Definition at line 30 of file MWTidy.php.

Referenced by setInstance(), and singleton().

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