aboutsummaryrefslogtreecommitdiffstats
path: root/includes/tidy/TidyDriverBase.php
blob: ced694e323a8773fed9d0d397639a956c8b1ef95 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?php

namespace MediaWiki\Tidy;

/**
 * Base class for HTML cleanup utilities
 */
abstract class TidyDriverBase {
	/** @var array */
	protected $config;

	public function __construct( $config ) {
		$this->config = $config;
	}

	/**
	 * Clean up HTML
	 *
	 * @param string $text HTML document fragment to clean up
	 * @param ?callable $textProcessor A callback to run on the contents of
	 *   text nodes (not elements or attribute values).  This can be used to
	 *   apply text modifications like french spacing or smart quotes, without
	 *   affecting element or attribute markup.
	 * @return string The corrected HTML output
	 */
	abstract public function tidy( $text, ?callable $textProcessor = null );
}