Code Coverage for /src/src/Ext/DOMProcessor.php

1	<?php
2	declare( strict_types = 1 );
3
4	namespace Wikimedia\Parsoid\Ext;
5
6	use Wikimedia\Parsoid\DOM\DocumentFragment;
7	use Wikimedia\Parsoid\DOM\Element;
8	use Wikimedia\Parsoid\DOM\Node;
9
10	/**
11	* A Parsoid extension module may contain one or more DOMProcessors,
12	* which allow Parsoid to post-process the DOM in the wt2html direction,
13	* or pre-process the DOM in the html2wt direction.
14	*/
15	abstract class DOMProcessor {
16
17	/**
18	* Post-process DOM in the wt2html direction.
19	*
20	* @param ParsoidExtensionAPI $extApi
21	* @param DocumentFragment\|Element $root The root of the tree to process
22	* @param array $options
23	* @param bool $atTopLevel Is this processor invoked on the top level page?
24	* If false, this is being invoked in a sub-pipeline (ex: extensions)
25	*/
26	public function wtPostprocess(
27	ParsoidExtensionAPI $extApi,
28	Node $root,
29	array $options,
30	bool $atTopLevel
31	): void {
32	/* do nothing by default */
33	}
34
35	/**
36	* Pre-process DOM in the html2wt direction.
37	*
38	* @param ParsoidExtensionAPI $extApi
39	* @param Element $root
40	*/
41	public function htmlPreprocess(
42	ParsoidExtensionAPI $extApi,
43	Element $root
44	): void {
45	/* do nothing by default */
46	}
47	}