Version 2.2.1
PHPHtmlParser is a simple, flexible, html parser which allows you to select tags using any css selector, like jQuery. The goal is to assist in the development of tools which require a quick, easy way to scrap html, whether it's valid or not!
Install the latest version using composer.
$ composer require paquettg/php-html-parserThis package can be found on packagist and is best loaded using composer. We support php 7.1, 7.2, 7.3, and 7.4.
You can find many examples of how to use the dom parser and any of its parts (which you will most likely never touch) in the tests directory. The tests are done using PHPUnit and are very small, a few lines each, and are a great place to start. Given that, I'll still be showing a few examples of how the package should be used. The following example is a very simplistic usage of the package.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
$dom = new Dom;
$dom->load('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>');
$a = $dom->find('a')[0];
echo $a->text; // "click here"The above will output "click here". Simple no? There are many ways to get the same result from the dome, such as $dom->getElementsbyTag('a')[0] or $dom->find('a', 0) which can all be found in the tests or in the code itself.
You may also seamlessly load a file into the dom instead of a string, which is much more convenient and is how I except most developers will be loading the html. The following example is taken from our test and uses the "big.html" file found there.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
$dom = new Dom;
$dom->loadFromFile('tests/data/big.html');
$contents = $dom->find('.content-border');
echo count($contents); // 10
foreach ($contents as $content)
{
// get the class attr
$class = $content->getAttribute('class');
// do something with the html
$html = $content->innerHtml;
// or refine the find some more
$child = $content->firstChild();
$sibling = $child->nextSibling();
}This example loads the html from big.html, a real page found online, and gets all the content-border classes to process. It also shows a few things you can do with a node but it is not an exhaustive list of methods that a node has available.
Alternativly, you can always use the load() method to load the file. It will attempt to find the file using file_exists and, if successful, will call loadFromFile() for you. The same applies to a URL and loadFromUrl() method.
Loading a url is very similar to the way you would load the html from a file.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
$dom = new Dom;
$dom->loadFromUrl('http://google.com');
$html = $dom->outerHtml;
// or
$dom->load('http://google.com');
$html = $dom->outerHtml; // same result as the first exampleWhat makes the loadFromUrl method note worthy is the PHPHtmlParser\CurlInterface parameter, an optional second parameter. By default, we use the PHPHtmlParser\Curl class to get the contents of the url. On the other hand, though, you can inject your own implementation of CurlInterface and we will attempt to load the url using what ever tool/settings you want, up to you.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
use App\Services\Connector;
$dom = new Dom;
$dom->loadFromUrl('http://google.com', [], new Connector);
$html = $dom->outerHtml;As long as the Connector object implements the PHPHtmlParser\CurlInterface interface properly it will use that object to get the content of the url instead of the default PHPHtmlParser\Curl class.
Loading a string directly, with out the checks in load() is also easily done.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
$dom = new Dom;
$dom->loadStr('<html>String</html>', []);
$html = $dom->outerHtml;If the string is to long, depending on your file system, the load() method will throw a warning. If this happens you can just call the above method to bypass the is_file() check in the load() method.
You can also set parsing option that will effect the behavior of the parsing engine. You can set a global option array using the setOptions method in the Dom object or a instance specific option by adding it to the load method as an extra (optional) parameter.
// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;
$dom = new Dom;
$dom->setOptions([
'strict' => true, // Set a global option to enable strict html parsing.
]);
$dom->load('http://google.com', [
'whitespaceTextNode' => false, // Only applies to this load.
]);
$dom->load('http://gmail.com'); // will not have whitespaceTextNode set to false.At the moment we support 8 options.
Strict
Strict, by default false, will throw a StrickException if it find that the html is not strictly compliant (all tags must have a closing tag, no attribute with out a value, etc.).
whitespaceTextNode
The whitespaceTextNode, by default true, option tells the parser to save textnodes even if the content of the node is empty (only whitespace). Setting it to false will ignore all whitespace only text node found in the document.
enforceEncoding
The enforceEncoding, by default null, option will enforce an character set to be used for reading the content and returning the content in that encoding. Setting it to null will trigger an attempt to figure out the encoding from within the content of the string given instead.
cleanupInput
Set this to false to skip the entire clean up phase of the parser. If this is set to true the next 3 options will be ignored. Defaults to true.
removeScripts
Set this to false to skip removing the script tags from the document body. This might have adverse effects. Defaults to true.
removeStyles
Set this to false to skip removing of style tags from the document body. This might have adverse effects. Defaults to true.
preserveLineBreaks
Preserves Line Breaks if set to true. If set to false line breaks are cleaned up as part of the input clean up process. Defaults to false.
removeDoubleSpace
Set this to false if you want to preserve whitespace inside of text nodes. It is set to true by default.
removeSmartyScripts
Set this to false if you want to preserve smarty script found in the html content. It is set to true by default.
depthFirstSearch
By default this is set to false for legacy support. Setting this to true will change the behavior of find to order elements by depth first. This will properly preserve the order of elements as they where in the HTML.
This option is depricated and will be removed in version 3.0.0 with the new behavior being as if it was set to true.
htmlSpecialCharsDecode
By default this is set to false. Setting this to true will apply the php function htmlspecialchars_decode too all attribute values and text nodes.
You can also mount a static facade for the Dom object.
PHPHtmlParser\StaticDom::mount();
Dom::load('tests/big.hmtl');
$objects = Dom::find('.content-border');The above php block does the same find and load as the first example but it is done using the static facade, which supports all public methods found in the Dom object.
You can always modify the dom that was created from any loading method. To change the attribute of any node you can just call the setAttribute method.
$dom = new Dom;
$dom->load('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>');
$a = $dom->find('a')[0];
$a->setAttribute('class', 'foo');
echo $a->getAttribute('class'); // "foo"You may also get the PHPHtmlParser\Dom\Tag class directly and manipulate it as you see fit.
$dom = new Dom;
$dom->load('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>');
$a = $dom->find('a')[0];
$tag = $a->getTag();
$tag->setAttribute('class', 'foo');
echo $a->getAttribute('class'); // "foo"It is also possible to remove a node from the tree. Simply call the delete method on any node to remove it from the tree. It is important to note that you should unset the node after removing it from the `DOM``, it will still take memory as long as it is not unset.
$dom = new Dom;
$dom->load('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>');
$a = $dom->find('a')[0];
$a->delete();
unset($a);
echo $dom; // '<div class="all"><p>Hey bro, <br /> :)</p></div>');You can modify the text of TextNode objects easely. Please note that, if you set an encoding, the new text will be encoded using the existing encoding.
$dom = new Dom;
$dom->load('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>');
$a = $dom->find('a')[0];
$a->firstChild()->setText('biz baz');
echo $dom; // '<div class="all"><p>Hey bro, <a href="google.com">biz baz</a><br /> :)</p></div>'