RulesInterface.php — Independent Analytics – WordPress Analytics Plugin 1.17

independent-analytics / vendor / masterminds / html5 / src / HTML5 / Serializer / RulesInterface.php

independent-analytics / vendor / masterminds / html5 / src / HTML5 / Serializer Last commit date

HTML5Entities.php 3 years ago OutputRules.php 3 years ago RulesInterface.php 3 years ago Traverser.php 3 years ago

RulesInterface.php

93 lines

1	<?php
2
3	/**
4	* @file
5	* The interface definition for Rules to generate output.
6	*/
7	namespace IAWP\Masterminds\HTML5\Serializer;
8
9	/**
10	* To create a new rule set for writing output the RulesInterface needs to be implemented.
11	* The resulting class can be specified in the options with the key of rules.
12	*
13	* For an example implementation see Serializer\OutputRules.
14	*/
15	interface RulesInterface
16	{
17	/**
18	* The class constructor.
19	*
20	* Note, before the rules can be used a traverser must be registered.
21	*
22	* @param mixed $output The output stream to write output to.
23	* @param array $options An array of options.
24	*/
25	public function __construct($output, $options = array());
26	/**
27	* Register the traverser used in but the rules.
28	*
29	* Note, only one traverser can be used by the rules.
30	*
31	* @param Traverser $traverser The traverser used in the rules.
32	*
33	* @return RulesInterface $this for the current object.
34	*/
35	public function setTraverser(Traverser $traverser);
36	/**
37	* Write a document element (\DOMDocument).
38	*
39	* Instead of returning the result write it to the output stream ($output)
40	* that was passed into the constructor.
41	*
42	* @param \DOMDocument $dom
43	*/
44	public function document($dom);
45	/**
46	* Write an element.
47	*
48	* Instead of returning the result write it to the output stream ($output)
49	* that was passed into the constructor.
50	*
51	* @param mixed $ele
52	*/
53	public function element($ele);
54	/**
55	* Write a text node.
56	*
57	* Instead of returning the result write it to the output stream ($output)
58	* that was passed into the constructor.
59	*
60	* @param mixed $ele
61	*/
62	public function text($ele);
63	/**
64	* Write a CDATA node.
65	*
66	* Instead of returning the result write it to the output stream ($output)
67	* that was passed into the constructor.
68	*
69	* @param mixed $ele
70	*/
71	public function cdata($ele);
72	/**
73	* Write a comment node.
74	*
75	* Instead of returning the result write it to the output stream ($output)
76	* that was passed into the constructor.
77	*
78	* @param mixed $ele
79	*/
80	public function comment($ele);
81	/**
82	* Write a processor instruction.
83	*
84	* To learn about processor instructions see InstructionProcessor
85	*
86	* Instead of returning the result write it to the output stream ($output)
87	* that was passed into the constructor.
88	*
89	* @param mixed $ele
90	*/
91	public function processorInstruction($ele);
92	}
93