interface RulesInterface in Zircon Profile 8

To create a new rule set for writing output the RulesInterface needs to be implemented. The resulting class can be specified in the options with the key of rules.

For an example implementation see \Masterminds\HTML5\Serializer\OutputRules.

Hierarchy

• interface \Masterminds\HTML5\Serializer\RulesInterface

File

vendor/masterminds/html5/src/HTML5/Serializer/RulesInterface.php, line 16

The interface definition for Rules to generate output.

Namespace

Masterminds\HTML5\Serializer

interface RulesInterface {

  /**
   * The class constructor.
   *
   * Note, before the rules can be used a traverser must be registered.
   *
   * @param mixed $output
   *            The output stream to write output to.
   * @param array $options
   *            An array of options.
   */
  public function __construct($output, $options = array());

  /**
   * Register the traverser used in but the rules.
   *
   * Note, only one traverser can be used by the rules.
   *
   * @param \Masterminds\HTML5\Serializer\Traverser $traverser
   *            The traverser used in the rules.
   * @return \Masterminds\HTML5\Serializer\RulesInterface $this for the current object.
   */
  public function setTraverser(\Masterminds\HTML5\Serializer\Traverser $traverser);

  /**
   * Write a document element (\DOMDocument).
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param \DOMDocument $dom
   */
  public function document($dom);

  /**
   * Write an element.
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param mixed $ele
   */
  public function element($ele);

  /**
   * Write a text node.
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param mixed $ele
   */
  public function text($ele);

  /**
   * Write a CDATA node.
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param mixed $ele
   */
  public function cdata($ele);

  /**
   * Write a comment node.
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param mixed $ele
   */
  public function comment($ele);

  /**
   * Write a processor instruction.
   *
   * To learn about processor instructions see \Masterminds\HTML5\InstructionProcessor
   *
   * Instead of returning the result write it to the output stream ($output)
   * that was passed into the constructor.
   *
   * @param mixed $ele
   */
  public function processorInstruction($ele);

}

Members

Name	Modifiers	Type	Description	Overrides
RulesInterface::cdata	public	function	Write a CDATA node.	1
RulesInterface::comment	public	function	Write a comment node.	1
RulesInterface::document	public	function	Write a document element (\DOMDocument).	1
RulesInterface::element	public	function	Write an element.	1
RulesInterface::processorInstruction	public	function	Write a processor instruction.	1
RulesInterface::setTraverser	public	function	Register the traverser used in but the rules.	1
RulesInterface::text	public	function	Write a text node.	1
RulesInterface::__construct	public	function	The class constructor.	1