Diogo Cordeiro dbe95c33c4 [aab] Revert structural change of v2 | 5 лет назад | |
---|---|---|
.. | ||
bin | 5 лет назад | |
src | 5 лет назад | |
test | 5 лет назад | |
.gitignore | 5 лет назад | |
.php_cs.dist | 5 лет назад | |
.scrutinizer.yml | 5 лет назад | |
.travis.yml | 5 лет назад | |
CREDITS | 5 лет назад | |
LICENSE.txt | 5 лет назад | |
README.md | 5 лет назад | |
RELEASE.md | 5 лет назад | |
UPGRADING.md | 5 лет назад | |
composer.json | 5 лет назад | |
example.php | 5 лет назад | |
phpunit.xml.dist | 5 лет назад | |
sami.php | 5 лет назад |
HTML5 is a standards-compliant HTML5 parser and writer written entirely in PHP. It is stable and used in many production websites, and has well over five million downloads.
HTML5 provides the following features.
Install HTML5-PHP using composer.
By adding the masterminds/html5
dependency to your composer.json
file:
{
"require" : {
"masterminds/html5": "^2.0"
},
}
By invoking require command via composer executable:
composer require masterminds/html5
HTML5-PHP has a high-level API and a low-level API.
Here is how you use the high-level HTML5
library API:
<?php
// Assuming you installed from Composer:
require "vendor/autoload.php";
use Masterminds\HTML5;
// An example HTML document:
$html = <<< 'HERE'
<html>
<head>
<title>TEST</title>
</head>
<body id='foo'>
<h1>Hello World</h1>
<p>This is a test of the HTML5 parser.</p>
</body>
</html>
HERE;
// Parse the document. $dom is a DOMDocument.
$html5 = new HTML5();
$dom = $html5->loadHTML($html);
// Render it as HTML5:
print $html5->saveHTML($dom);
// Or save it to a file:
$html5->save($dom, 'out.html');
The $dom
created by the parser is a full DOMDocument
object. And the
save()
and saveHTML()
methods will take any DOMDocument.
It is possible to pass in an array of configuration options when loading an HTML5 document.
// An associative array of options
$options = array(
'option_name' => 'option_value',
);
// Provide the options to the constructor
$html5 = new HTML5($options);
$dom = $html5->loadHTML($html);
The following options are supported:
encode_entities
(boolean): Indicates that the serializer should aggressively
encode characters as entities. Without this, it only encodes the bare
minimum.disable_html_ns
(boolean): Prevents the parser from automatically
assigning the HTML5 namespace to the DOM document. This is for
non-namespace aware DOM tools.target_document
(\DOMDocument): A DOM document that will be used as the
destination for the parsed nodes.implicit_namespaces
(array): An assoc array of namespaces that should be
used by the parser. Name is tag prefix, value is NS URI.This library provides the following low-level APIs that you can use to create more customized HTML5 tools:
The unit tests exercise each piece of the API, and every public function is well-documented.
The parser is designed as follows:
Scanner
handles scanning on behalf of the parser.Tokenizer
requests data off of the scanner, parses it, clasifies
it, and sends it to an EventHandler
. It is a recursive descent parser.EventHandler
receives notifications and data for each specific
semantic event that occurs during tokenization.DOMBuilder
is an EventHandler
that listens for tokenizing
events and builds a document tree (DOMDocument
) based on the events.The serializer takes a data structure (the DOMDocument
) and transforms
it into a character representation -- an HTML5 document.
The serializer is broken into three parts:
OutputRules
contain the rules to turn DOM elements into strings. The
rules are an implementation of the interface RulesInterface
allowing for
different rule sets to be used.Traverser
, which is a special-purpose tree walker. It visits
each node node in the tree and uses the OutputRules
to transform the node
into a string.HTML5
manages the Traverser
and stores the resultant data
in the correct place.The serializer (save()
, saveHTML()
) follows the
section 8.9 of the HTML 5.0 spec.
So tags are serialized according to these rules:
Please check the issue queue for a full list, but the following are issues known issues that are not presently on the roadmap:
:
has no special
meaning.
By default the parser does not support XML style namespaces via :
;
to enable the XML namespaces see the XML Namespaces sectionTo use XML style namespaces you have to configure well the main HTML5
instance.
use Masterminds\HTML5;
$html = new HTML5(array(
"xmlNamespaces" => true
));
$dom = $html->loadHTML('<t:tag xmlns:t="http://www.example.com"/>');
$dom->documentElement->namespaceURI; // http://www.example.com
You can also add some default prefixes that will not require the namespace declaration, but its elements will be namespaced.
use Masterminds\HTML5;
$html = new HTML5(array(
"implicitNamespaces"=>array(
"t"=>"http://www.example.com"
)
));
$dom = $html->loadHTML('<t:tag/>');
$dom->documentElement->namespaceURI; // http://www.example.com
The dedicated (and patient) contributors of patches small and large, who have already made this library better.See the CREDITS file for a list of contributors.
We owe a huge debt of gratitude to the original authors of html5lib.
While not much of the original parser remains, we learned a lot from reading the html5lib library. And some pieces remain here. In particular, much of the UTF-8 and Unicode handling is derived from the html5lib project.
This software is released under the MIT license. The original html5lib library was also released under the MIT license.
See LICENSE.txt
Certain files contain copyright assertions by specific individuals involved with html5lib. Those have been retained where appropriate.