Index | HTML5-PHP API

A

OutputRules::addRule() — Method in class OutputRules

B

$Entities — Property in class Entities

C

CharacterReference — Class in namespace Masterminds\HTML5\Parser: Manage entity references.
DOMTreeBuilder::comment() — Method in class DOMTreeBuilder: A comment section (unparsed character data).
DOMTreeBuilder::cdata() — Method in class DOMTreeBuilder: A CDATA section.
EventHandler::comment() — Method in class EventHandler: A comment section (unparsed character data).
EventHandler::cdata() — Method in class EventHandler: A CDATA section.
InputStream::currentLine() — Method in class InputStream: Returns the current line that is being consumed.
InputStream::columnOffset() — Method in class InputStream: Returns the current column of the current line that the tokenizer is at.
InputStream::charsUntil() — Method in class InputStream: Read to a particular match (or until $max bytes are consumed).
InputStream::charsWhile() — Method in class InputStream: Returns the string so long as $bytes matches.
Scanner::current() — Method in class Scanner: Get the current character.
Scanner::consume() — Method in class Scanner: Silently consume N chars.
Scanner::currentLine() — Method in class Scanner: Returns the current line that is being consumed.
Scanner::charsUntil() — Method in class Scanner: Read chars until something in the mask is encountered.
Scanner::charsWhile() — Method in class Scanner: Read chars as long as the mask matches.
Scanner::columnOffset() — Method in class Scanner: Returns the current column of the current line that the tokenizer is at.
StringInputStream::currentLine() — Method in class StringInputStream: Returns the current line that the tokenizer is at.
StringInputStream::columnOffset() — Method in class StringInputStream: Returns the current column of the current line that the tokenizer is at.
StringInputStream::current() — Method in class StringInputStream: Get the current character.
StringInputStream::charsUntil() — Method in class StringInputStream: Read to a particular match (or until $max bytes are consumed).
StringInputStream::charsWhile() — Method in class StringInputStream: Returns the string so long as $bytes matches.
UTF8Utils::countChars() — Method in class UTF8Utils: Count the number of characters in a string.
UTF8Utils::convertToUTF8() — Method in class UTF8Utils: Convert data from the given encoding to UTF-8.
UTF8Utils::checkForIllegalCodepoints() — Method in class UTF8Utils: Checks for Unicode code points that are not valid in a document.
OutputRules::cdata() — Method in class OutputRules: Write a CDATA node.
OutputRules::comment() — Method in class OutputRules: Write a comment node.
RulesInterface::cdata() — Method in class RulesInterface: Write a CDATA node.
RulesInterface::comment() — Method in class RulesInterface: Write a comment node.
Traverser::children() — Method in class Traverser: Walk through all the nodes on a node list.

D

DOMTreeBuilder — Class in namespace Masterminds\HTML5\Parser: Create an HTML5 DOM tree from events.
DOMTreeBuilder::document() — Method in class DOMTreeBuilder: Get the document.
DOMTreeBuilder::doctype() — Method in class DOMTreeBuilder: A doctype declaration.
EventHandler::doctype() — Method in class EventHandler: A doctype declaration.
$Scanner — Property in class Scanner
OutputRules::document() — Method in class OutputRules: Write a document element (\DOMDocument).
RulesInterface::document() — Method in class RulesInterface: Write a document element (\DOMDocument).

E

Elements — Class in namespace Masterminds\HTML5: This class provides general information about HTML5 elements, including syntactic and semantic issues.
Elements::element() — Method in class Elements: Get the element mask for the given element name.
Entities — Class in namespace Masterminds\HTML5: Entity lookup tables.
Exception — Class in namespace Masterminds\HTML5: The base exception for the HTML5 project.
DOMTreeBuilder::endTag() — Method in class DOMTreeBuilder: An end-tag.
DOMTreeBuilder::eof() — Method in class DOMTreeBuilder: Indicates that the document has been entirely processed.
EventHandler — Class in namespace Masterminds\HTML5\Parser: Standard events for HTML5.
EventHandler::endTag() — Method in class EventHandler: An end-tag.
EventHandler::eof() — Method in class EventHandler: Indicates that the document has been entirely processed.
$StringInputStream — Property in class StringInputStream: Parse errors.
TreeBuildingRules::evaluate() — Method in class TreeBuildingRules: Evaluate the rule for the current tag name.
OutputRules::element() — Method in class OutputRules: Write an element.
RulesInterface::element() — Method in class RulesInterface: Write an element.

F

DOMTreeBuilder::fragment() — Method in class DOMTreeBuilder: Get the DOM fragment for the body.
FileInputStream — Class in namespace Masterminds\HTML5\Parser: The FileInputStream loads a file to be parsed.

G

HTML5::getOptions() — Method in class HTML5: Get the default options.
HTML5::getErrors() — Method in class HTML5: Return all errors encountered into parsing phase
DOMTreeBuilder::getErrors() — Method in class DOMTreeBuilder
Scanner::getHex() — Method in class Scanner: Get the next group of that contains hex characters.
Scanner::getAsciiAlpha() — Method in class Scanner: Get the next group of characters that are ASCII Alpha characters.
Scanner::getAsciiAlphaNum() — Method in class Scanner: Get the next group of characters that are ASCII Alpha characters and numbers.
Scanner::getNumeric() — Method in class Scanner: Get the next group of numbers.
StringInputStream::getCurrentLine() — Method in class StringInputStream
StringInputStream::getColumnOffset() — Method in class StringInputStream

H

HTML5 — Class in namespace Masterminds: This class offers convenience methods for parsing and serializing HTML5.
HTML5::hasErrors() — Method in class HTML5: Return true it some errors were encountered into parsing phase
$Elements — Property in class Elements: The HTML5 elements as defined in http://dev.w3.org/html5/markup/elements.html.
TreeBuildingRules::hasRules() — Method in class TreeBuildingRules: Returns true if the given tagname has special processing rules.
HTML5Entities — Class in namespace Masterminds\HTML5\Serializer: A mapping of entities to their html5 representation.

I

Elements::isA() — Method in class Elements: Check whether the given element meets the given criterion.
Elements::isHtml5Element() — Method in class Elements: Test if an element is a valid html5 element.
Elements::isMathMLElement() — Method in class Elements: Test if an element name is a valid MathML presentation element.
Elements::isSvgElement() — Method in class Elements: Test if an element is a valid SVG element.
Elements::isElement() — Method in class Elements: Is an element name valid in an html5 document.
InstructionProcessor — Class in namespace Masterminds\HTML5: Provide an processor to handle embedded instructions.
InputStream — Class in namespace Masterminds\HTML5\Parser: Interface for stream readers.
Traverser::isLocalElement() — Method in class Traverser: Is an element local?

K

StringInputStream::key() — Method in class StringInputStream

L

HTML5::load() — Method in class HTML5: Load and parse an HTML file.
HTML5::loadHTML() — Method in class HTML5: Parse a HTML Document from a string.
HTML5::loadHTMLFile() — Method in class HTML5: Convenience function to load an HTML file.
HTML5::loadHTMLFragment() — Method in class HTML5: Parse a HTML fragment from a string.
CharacterReference::lookupName() — Method in class CharacterReference: Given a name (e.g.
CharacterReference::lookupDecimal() — Method in class CharacterReference: Given a decimal number, return the UTF-8 character.
CharacterReference::lookupHex() — Method in class CharacterReference: Given a hexidecimal number, return the UTF-8 character.
$Traverser — Property in class Traverser: Namespaces that should be treated as "local" to HTML5.

M

$Elements — Property in class Elements: The MathML elements.
$HTML5Entities — Property in class HTML5Entities

N

Elements::normalizeSvgElement() — Method in class Elements: Normalize a SVG element name to its proper case and form.
Elements::normalizeSvgAttribute() — Method in class Elements: Normalize a SVG attribute name to its proper case and form.
Elements::normalizeMathMlAttribute() — Method in class Elements: Normalize a MathML attribute name to its proper case and form.
Scanner::next() — Method in class Scanner: Get the next character.
StringInputStream::next() — Method in class StringInputStream: Advance the pointer.
Traverser::node() — Method in class Traverser: Process a node in the DOM.

O

OutputRules — Class in namespace Masterminds\HTML5\Serializer: Generate the output html5 based on element rules.

P

HTML5::parse() — Method in class HTML5: Parse an input stream.
HTML5::parseFragment() — Method in class HTML5: Parse an input stream where the stream is a fragment.
InstructionProcessor::process() — Method in class InstructionProcessor: Process an individual processing instruction.
DOMTreeBuilder::parseError() — Method in class DOMTreeBuilder: Emitted when the parser encounters an error condition.
DOMTreeBuilder::processingInstruction() — Method in class DOMTreeBuilder: This is a holdover from the XML spec.
EventHandler::parseError() — Method in class EventHandler: Emitted when the parser encounters an error condition.
EventHandler::processingInstruction() — Method in class EventHandler: This is a holdover from the XML spec.
InputStream::peek() — Method in class InputStream: Retrieve the next character without advancing the pointer.
ParseError — Class in namespace Masterminds\HTML5\Parser: Emit when the parser has an error.
Scanner::position() — Method in class Scanner: Get the current position.
Scanner::peek() — Method in class Scanner: Take a peek at the next character in the data.
StringInputStream::peek() — Method in class StringInputStream: Look ahead without moving cursor.
Tokenizer::parse() — Method in class Tokenizer: Begin parsing.
OutputRules::processorInstruction() — Method in class OutputRules: Write a processor instruction.
RulesInterface::processorInstruction() — Method in class RulesInterface: Write a processor instruction.

R

InputStream::remainingChars() — Method in class InputStream: Get all characters until EOF.
Scanner::remainingChars() — Method in class Scanner: Get all characters until EOF.
StringInputStream::rewind() — Method in class StringInputStream: Rewind to the start of the string.
StringInputStream::remainingChars() — Method in class StringInputStream: Get all characters until EOF.
RulesInterface — Class in namespace Masterminds\HTML5\Serializer: To create a new rule set for writing output the RulesInterface needs to be implemented.

S

HTML5::save() — Method in class HTML5: Save a DOM into a given file as HTML5.
HTML5::saveHTML() — Method in class HTML5: Convert a DOM into an HTML5 string.
$Elements — Property in class Elements: The svg elements.
$Elements — Property in class Elements: Some attributes in SVG are case sensetitive.
$Elements — Property in class Elements: Some SVG elements are case sensetitive.
DOMTreeBuilder::setInstructionProcessor() — Method in class DOMTreeBuilder: Provide an instruction processor.
DOMTreeBuilder::startTag() — Method in class DOMTreeBuilder: A start tag.
EventHandler::startTag() — Method in class EventHandler: A start tag.
Scanner — Class in namespace Masterminds\HTML5\Parser: The scanner.
StringInputStream — Class in namespace Masterminds\HTML5\Parser
Tokenizer::setTextMode() — Method in class Tokenizer: Set the text mode for the character data reader.
OutputRules::setTraverser() — Method in class OutputRules: Register the traverser used in but the rules.
RulesInterface::setTraverser() — Method in class RulesInterface: Register the traverser used in but the rules.

T

DOMTreeBuilder::text() — Method in class DOMTreeBuilder: A unit of parsed character data.
EventHandler::text() — Method in class EventHandler: A unit of parsed character data.
Tokenizer — Class in namespace Masterminds\HTML5\Parser: The HTML5 tokenizer.
TreeBuildingRules — Class in namespace Masterminds\HTML5\Parser: Handles special-case rules for the DOM tree builder.
OutputRules::text() — Method in class OutputRules: Write a text node.
RulesInterface::text() — Method in class RulesInterface: Write a text node.
Traverser — Class in namespace Masterminds\HTML5\Serializer: Traverser for walking a DOM tree.

U

InputStream::unconsume() — Method in class InputStream: Unconsume one character.
Scanner::unconsume() — Method in class Scanner: Unconsume some of the data.
StringInputStream::unconsume() — Method in class StringInputStream: Unconsume characters.
UTF8Utils — Class in namespace Masterminds\HTML5\Parser: UTF-8 Utilities

V

StringInputStream::valid() — Method in class StringInputStream: Is the current pointer location valid.

W

Scanner::whitespace() — Method in class Scanner: Consume whitespace.
Traverser::walk() — Method in class Traverser: Tell the traverser to walk the DOM.

_

HTML5::__construct() — Method in class HTML5
DOMTreeBuilder::__construct() — Method in class DOMTreeBuilder
FileInputStream::__construct() — Method in class FileInputStream: Load a file input stream.
Scanner::__construct() — Method in class Scanner: Create a new Scanner.
StringInputStream::__construct() — Method in class StringInputStream: Create a new InputStream wrapper.
Tokenizer::__construct() — Method in class Tokenizer: Create a new tokenizer.
TreeBuildingRules::__construct() — Method in class TreeBuildingRules: Build a new rules engine.
OutputRules::__construct() — Method in class OutputRules: The class constructor.
RulesInterface::__construct() — Method in class RulesInterface: The class constructor.
Traverser::__construct() — Method in class Traverser: Create a traverser.