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

Class to interact with HTML tidy. More...

Static Public Member Functions

static checkErrors ( $text, &$errorStr=null)
 Check HTML for errors, used if $wgValidateAllHtml = true.
 
static destroySingleton ()
 Destroy the current singleton instance.
 
static getModuleStyles ()
 Get CSS modules needed if HTML from the current driver is to be displayed.
 
static isEnabled ()
 
static setInstance ( $instance)
 Set the driver to be used.
 
static tidy ( $text)
 Interface with html tidy.
 

Static Protected Member Functions

static singleton ()
 

Static Private Attributes

static $instance
 

Detailed Description

Class to interact with HTML tidy.

Either the external tidy program or the in-process tidy extension will be used depending on availability. Override the default $wgTidyInternal setting to disable the internal if it's not working.

Definition at line 33 of file MWTidy.php.

Member Function Documentation

◆ checkErrors()

static MWTidy::checkErrors (   $text,
&  $errorStr = null 
)
static

Check HTML for errors, used if $wgValidateAllHtml = true.

Parameters
string$text
string&$errorStrReturn the error string
Returns
bool Whether the HTML is valid
Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 79 of file MWTidy.php.

References singleton().

Referenced by MediaWikiTestCase\assertValidHtmlDocument(), and wfHtmlValidationHandler().

◆ destroySingleton()

static MWTidy::destroySingleton ( )
static

Destroy the current singleton instance.

Definition at line 153 of file MWTidy.php.

Referenced by TextContentTest\setUp(), ParserTest\setupGlobals(), NewParserTest\setupGlobals(), TextContentTest\tearDown(), NewParserTest\tearDown(), SanitizerTest\tearDown(), and ParserTest\teardownGlobals().

◆ getModuleStyles()

static MWTidy::getModuleStyles ( )
static

Get CSS modules needed if HTML from the current driver is to be displayed.

This is just a migration tool to allow some changes expected as part of Tidy replacement (T89331) to be exposed on the client side via user scripts, without actually replacing tidy. See T49673.

Returns
array

Definition at line 63 of file MWTidy.php.

References singleton().

Referenced by Parser\internalParseHalfParsed().

◆ isEnabled()

static MWTidy::isEnabled ( )
static
Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 92 of file MWTidy.php.

References singleton().

Referenced by MediaWikiTestCase\assertValidHtmlDocument(), Parser\internalParseHalfParsed(), Sanitizer\removeHTMLtags(), and TidyTest\setUp().

◆ setInstance()

static MWTidy::setInstance (   $instance)
static

Set the driver to be used.

This is for testing.

Parameters
TidyDriverBase | false | null$instance

Definition at line 146 of file MWTidy.php.

References $instance.

Referenced by SanitizerTest\testRemoveHTMLtags(), and SanitizerTest\testRemovehtmltagsOnHtml5Tags().

◆ singleton()

static MWTidy::singleton ( )
staticprotected

Definition at line 96 of file MWTidy.php.

References $instance, $wgDebugTidy, $wgTidyBin, $wgTidyConf, $wgTidyConfig, $wgTidyInternal, $wgTidyOpts, $wgUseTidy, global, and wfIsHHVM().

Referenced by checkErrors(), getModuleStyles(), isEnabled(), and tidy().

◆ tidy()

static MWTidy::tidy (   $text)
static

Interface with html 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

Definition at line 45 of file MWTidy.php.

References singleton().

Referenced by SpecialExpandTemplates\execute(), Parser\internalParseHalfParsed(), and TidyTest\testTidyWrapping().

Member Data Documentation

◆ $instance

MWTidy::$instance
staticprivate

Definition at line 34 of file MWTidy.php.

Referenced by setInstance(), and singleton().

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