MediaWiki  master
MWTidy Class Reference

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 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 83 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 75 of file MWTidy.php.

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

◆ isEnabled()

static MWTidy::isEnabled ( )
static
Returns
bool
Deprecated:
since 1.35; tidy is always enabled

Definition at line 51 of file MWTidy.php.

◆ singleton()

static MWTidy::singleton ( )
static
Returns
bool|\MediaWiki\Tidy\TidyDriverBase
Deprecated:
since 1.35; use MWTidy::tidy()

Definition at line 59 of file MWTidy.php.

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

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

◆ 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(), and Parser\internalParseHalfParsed().

Member Data Documentation

◆ $instance

MWTidy::$instance
staticprivate

Definition at line 30 of file MWTidy.php.

Referenced by singleton().


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