Base class for HTML cleanup utilities. More...

Inheritance diagram for MediaWiki\Tidy\TidyDriverBase:

[legend]

Public Member Functions
	__construct ( $config)

	supportsValidate ()
	Return true if validate() can be used.

	tidy ( $text)
	Clean up HTML.

	validate ( $text, &$errorStr)
	Check HTML for errors, used if $wgValidateAllHtml = true.

Protected Attributes
	$config

Detailed Description

Base class for HTML cleanup utilities.

Definition at line 8 of file TidyDriverBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Tidy\TidyDriverBase::__construct ( $config )

Definition at line 11 of file TidyDriverBase.php.

References MediaWiki\Tidy\TidyDriverBase\$config.

Member Function Documentation

◆ supportsValidate()

MediaWiki\Tidy\TidyDriverBase::supportsValidate ( )

Return true if validate() can be used.

Returns: bool

Reimplemented in MediaWiki\Tidy\RaggettExternal, and MediaWiki\Tidy\RaggettInternalPHP.

Definition at line 19 of file TidyDriverBase.php.

◆ tidy()

MediaWiki\Tidy\TidyDriverBase::tidy ( $text )

abstract

Clean up HTML.

Parameters

string $text HTML document fragment to clean up

Returns: string The corrected HTML output

Reimplemented in MediaWiki\Tidy\Html5Depurate, MediaWiki\Tidy\Html5Internal, MediaWiki\Tidy\RaggettBase, and MediaWiki\Tidy\RemexDriver.

◆ validate()

MediaWiki\Tidy\TidyDriverBase::validate	(		$text,
		&	$errorStr )

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

Parameters

string	$text
string	&$errorStr	Return the error string

Exceptions

\MWException

Returns: bool Whether the HTML is valid

Reimplemented in MediaWiki\Tidy\RaggettBase.

Definition at line 31 of file TidyDriverBase.php.

Member Data Documentation

◆ $config

MediaWiki\Tidy\TidyDriverBase::$config

protected

Definition at line 9 of file TidyDriverBase.php.

Referenced by MediaWiki\Tidy\TidyDriverBase\__construct(), MediaWiki\Tidy\Html5Depurate\__construct(), MediaWiki\Tidy\Html5Internal\__construct(), and MediaWiki\Tidy\RemexDriver\__construct().

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

includes/tidy/TidyDriverBase.php

Public Member Functions

Protected Attributes