MediaWiki  1.29.1
MediaWiki\Tidy\RaggettBase Class Reference
Inheritance diagram for MediaWiki\Tidy\RaggettBase:
Collaboration diagram for MediaWiki\Tidy\RaggettBase:

Public Member Functions

 tidy ( $text)
 Generic interface for wrapping and unwrapping HTML for Dave Raggett's tidy. More...
 
 validate ( $text, &$errorStr)
 Check HTML for errors, used if $wgValidateAllHtml = true. More...
 
- Public Member Functions inherited from MediaWiki\Tidy\TidyDriverBase
 __construct ( $config)
 
 supportsValidate ()
 Return true if validate() can be used. More...
 

Protected Member Functions

 cleanWrapped ( $text, $stderr=false, &$retval=null)
 Perform a clean/repair operation. More...
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Tidy\TidyDriverBase
 $config
 

Detailed Description

Definition at line 5 of file RaggettBase.php.

Member Function Documentation

◆ cleanWrapped()

MediaWiki\Tidy\RaggettBase::cleanWrapped (   $text,
  $stderr = false,
$retval = null 
)
abstractprotected

Perform a clean/repair operation.

Parameters
string$textHTML to check
bool$stderrWhether to read result from STDERR rather than STDOUT
int&$retvalExit code (-1 on internal error)
Returns
null|string
Exceptions
MWException

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

Referenced by MediaWiki\Tidy\RaggettBase\tidy(), and MediaWiki\Tidy\RaggettBase\validate().

◆ tidy()

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

Generic interface for wrapping and unwrapping HTML for Dave Raggett's tidy.

Parameters
string$textHideous HTML input
Returns
string Corrected HTML output

Reimplemented from MediaWiki\Tidy\TidyDriverBase.

Definition at line 12 of file RaggettBase.php.

References MediaWiki\Tidy\RaggettBase\cleanWrapped(), MediaWiki\Tidy\RaggettWrapper\getWrapped(), and wfDebug().

◆ validate()

MediaWiki\Tidy\RaggettBase::validate (   $text,
$errorStr 
)

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

Parameters
string$text
string&$errorStrReturn the error string
Returns
bool Whether the HTML is valid

Reimplemented from MediaWiki\Tidy\TidyDriverBase.

Definition at line 32 of file RaggettBase.php.

References $retval, and MediaWiki\Tidy\RaggettBase\cleanWrapped().


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