full-text-rss/libraries/html5php/HTML5/InstructionProcessor.php

44 lines
1.7 KiB
PHP
Raw Normal View History

2014-09-15 20:24:06 +00:00
<?php
/**
* A handler for processor instructions.
*/
2015-06-14 00:03:20 +00:00
namespace Masterminds\HTML5;
2014-09-15 20:24:06 +00:00
/**
* Provide an processor to handle embedded instructions.
*
2015-06-14 00:03:20 +00:00
* XML defines a mechanism for inserting instructions (like PHP) into a
* document. These are called "Processor Instructions." The HTML5 parser
* provides an opportunity to handle these processor instructions during
* the tree-building phase (before the DOM is constructed), which makes
2014-09-15 20:24:06 +00:00
* it possible to alter the document as it is being created.
*
* One could, for example, use this mechanism to execute well-formed PHP
* code embedded inside of an HTML5 document.
*/
2015-06-14 00:03:20 +00:00
interface InstructionProcessor
{
2014-09-15 20:24:06 +00:00
2015-06-14 00:03:20 +00:00
/**
* Process an individual processing instruction.
*
* The process() function is responsible for doing the following:
* - Determining whether $name is an instruction type it can handle.
* - Determining what to do with the data passed in.
* - Making any subsequent modifications to the DOM by modifying the
* DOMElement or its attached DOM tree.
*
* @param DOMElement $element
* The parent element for the current processing instruction.
* @param string $name
* The instruction's name. E.g. `&lt;?php` has the name `php`.
* @param string $data
* All of the data between the opening and closing PI marks.
* @return DOMElement The element that should be considered "Current". This may just be
* the element passed in, but if the processor added more elements,
* it may choose to reset the current element to one of the elements
* it created. (When in doubt, return the element passed in.)
*/
public function process(\DOMElement $element, $name, $data);
2014-09-15 20:24:06 +00:00
}