MediaWiki REL1_28
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 factory (array $config)
 Create a new Tidy driver object from configuration.
 
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
Exceptions
MWException
Examples
/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 63 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 160 of file MWTidy.php.

Referenced by ParserTestRunner\perTestSetup(), TextContentTest\setUp(), TextContentTest\tearDown(), and SanitizerTest\tearDown().

◆ factory()

static MWTidy::factory ( array  $config)
static

Create a new Tidy driver object from configuration.

See also
$wgTidyConfig
Parameters
array$config
Returns
bool|\MediaWiki\Tidy\TidyDriverBase
Exceptions
MWException

Definition at line 124 of file MWTidy.php.

References $instance.

Referenced by ParserTestRunner\perTestSetup(), and singleton().

◆ isEnabled()

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

Definition at line 79 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
MediaWiki\\Tidy\\TidyDriverBase | false | null$instance

Definition at line 153 of file MWTidy.php.

References $instance.

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

◆ singleton()

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

Definition at line 86 of file MWTidy.php.

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

Referenced by checkErrors(), 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
Exceptions
MWException

Definition at line 46 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 factory(), setInstance(), and singleton().

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