wiki.techinc.nl/includes/tidy/TidyDriverBase.php
Thiemo Mättig 53c5a52970 Fix various mistakes in PHPDoc comments
Change-Id: I434207f61e0663f2d2c9a076296c2e0d04a3fafb
2015-12-09 18:20:41 +01:00

40 lines
820 B
PHP

<?php
namespace MediaWiki\Tidy;
/**
* Base class for HTML cleanup utilities
*/
abstract class TidyDriverBase {
protected $config;
function __construct( $config ) {
$this->config = $config;
}
/**
* Return true if validate() can be used
*/
public function supportsValidate() {
return false;
}
/**
* Check HTML for errors, used if $wgValidateAllHtml = true.
*
* @param string $text
* @param string &$errorStr Return the error string
* @return bool Whether the HTML is valid
*/
public function validate( $text, &$errorStr ) {
throw new MWException( get_class( $this ) . " does not support validate()" );
}
/**
* Clean up HTML
*
* @param string $text HTML document fragment to clean up
* @return string The corrected HTML output
*/
abstract public function tidy( $text );
}