DiDOM - simple and fast HTML parser.
- Installation
- Quick start
- Creating new document
- Search for elements
- Verify if element exists
- Supported selectors
- Output
- Creating a new element
- Getting parent element
- Getting sibling elements
- Getting the child elements
- Getting document
- Working with element attributes
- Comparing elements
- Adding a child element
- Replacing element
- Removing element
- Working with cache
- Comparison with other parsers
To install DiDOM run the command:
composer require imangazaliev/didom
use DiDom\Document;
$document = new Document('http://www.news.com/', true);
$posts = $document->find('.post');
foreach($posts as $post) {
echo $post->text(), "\n";
}
DiDom allows to load HTML in several ways:
// the first parameter is a string with HTML
$document = new Document($html);
// file path
$document = new Document('page.html', true);
// or URL
$document = new Document('http://www.example.com/', true);
The second parameter specifies if you need to load file. Default is false
.
$document = new Document();
$document->loadHtml($html);
$document->loadHtmlFile('page.html');
$document->loadHtmlFile('http://www.example.com/');
There are two methods available for loading XML: loadXml
and loadXmlFile
.
These methods accept additional options:
$document->loadHtml($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
DiDOM accepts CSS selector or XPath as an expression for search. You need to path expression as the first parameter, and specify its type in the second one (default type is Query::TYPE_CSS
):
use DiDom\Document;
use DiDom\Query;
...
// CSS selector
$posts = $document->find('.post');
// XPath
$posts = $document->find("//div[contains(@class, 'post')]", Query::TYPE_XPATH);
$posts = $document('.post');
$posts = $document->xpath("//*[contains(concat(' ', normalize-space(@class), ' '), ' post ')]");
You can do search inside an element:
echo $document->find('.post')[0]->find('h2')[0]->text();
If the elements that match a given expression are found, then method returns an array of instances of DiDom\Element
, otherwise - an empty array. You could also get an array of DOMElement
objects. To get this, pass false
as the third parameter.
To verify if element exist use has()
method:
if ($document->has('.post')) {
// code
}
If you need to check if element exist and then get it:
if ($document->has('.post')) {
$elements = $document->find('.post');
// code
}
but it would be faster like this:
if (count($elements = $document->find('.post')) > 0) {
// code
}
because in the first case it makes two requests.
DiDom supports search by:
- tag
- class, ID, name and value of an attribute
- pseudo-classes:
- first-, last-, nth-child
- empty and not-empty
- contains
- has
// all links
$document->find('a');
// any element with id = "foo" and "bar" class
$document->find('#foo.bar');
// any element with attribute "name"
$document->find('[name]');
// the same as
$document->find('*[name]');
// input field with the name "foo"
$document->find('input[name=foo]');
$document->find('input[name=\'bar\']');
$document->find('input[name="baz"]');
// any element that has an attribute starting with "data-" and the value "foo"
$document->find('*[^data-=foo]');
// all links starting with https
$document->find('a[href^=https]');
// all images with the extension png
$document->find('img[src$=png]');
// all links containing the string "example.com"
$document->find('a[href*=example.com]');
// text of the links with "foo" class
$document->find('a.foo::text');
// address and title of all the fields with "bar" class
$document->find('a.bar::attr(href|title)');
$posts = $document->find('.post');
echo $posts[0]->html();
$html = (string) $posts[0];
$html = $document->format()->html();
An element does not have format()
method, so if you need to output formatted HTML of the element, then first you have to convert it to a document:
$html = $element->toDocument()->format()->html();
$innerHtml = $element->innerHtml();
Document does not have the method innerHtml()
, therefore, if you need to get inner HTML of a document, convert it into an element first:
$innerHtml = $document->toElement()->innerHtml();
$html = $document->format()->html(LIBXML_NOEMPTYTAG);
$posts = $document->find('.post');
echo $posts[0]->text();
use DiDom\Element;
$element = new Element('span', 'Hello');
// Outputs "<span>Hello</span>"
echo $element->html();
First parameter is a name of an attribute, the second one is its value (optional), the third one is element attributes (optional).
An example of creating an element with attributes:
$attributes = ['name' => 'description', 'placeholder' => 'Enter description of item'];
$element = new Element('textarea', 'Text', $attributes);
An element can be created from an instance of the class DOMElement
:
use DiDom\Element;
use DOMElement;
$domElement = new DOMElement('span', 'Hello');
$element = new Element($domElement);
$document = new Document($html);
$element = $document->createElement('span', 'Hello');
$document = new Document($html);
$input = $document->find('input[name=email]')[0];
var_dump($input->parent());
$document = new Document($html);
$item = $document->find('ul.menu > li')[1];
var_dump($item->previousSibling());
var_dump($item->nextSibling());
$html = '
<ul>
<li>Foo</li>
<li>Bar</li>
<li>Baz</li>
</ul>
';
$document = new Document($html);
$list = $document->first('ul');
// string(3) "Baz"
var_dump($item->child(2)->text());
// string(3) "Foo"
var_dump($item->firstChild()->text());
// string(3) "Baz"
var_dump($item->lastChild()->text());
// array(3) { ... }
var_dump($item->children());
$document = new Document($html);
$element = $document->find('input[name=email]')[0];
$document2 = $element->getDocument();
// bool(true)
var_dump($document->is($document2));
$name = $element->tag;
$element->setAttribute('name', 'username');
$element->attr('name', 'username');
$element->name = 'username';
$username = $element->getAttribute('value');
$username = $element->attr('value');
$username = $element->name;
Returns null
if attribute is not found.
if ($element->hasAttribute('name')) {
// code
}
if (isset($element->name)) {
// code
}
$element->removeAttribute('name');
unset($element->name);
$element = new Element('span', 'hello');
$element2 = new Element('span', 'hello');
// bool(true)
var_dump($element->is($element));
// bool(false)
var_dump($element->is($element2));
$list = new Element('ul');
$item = new Element('li', 'Item 1');
$list->appendChild($item);
$items = [
new Element('li', 'Item 2'),
new Element('li', 'Item 3'),
];
$list->appendChild($items);
$list = new Element('ul');
$item = new Element('li', 'Item 1');
$items = [
new Element('li', 'Item 2'),
new Element('li', 'Item 3'),
];
$list->appendChild($item);
$list->appendChild($items);
$element = new Element('span', 'hello');
$document->find('.post')[0]->replace($element);
$document->find('.post')[0]->remove();
Cache is an array of XPath expressions, that were converted from CSS.
use DiDom\Query;
...
$xpath = Query::compile('h2');
$compiled = Query::getCompiled();
// array('h2' => '//h2')
var_dump($compiled);
Query::setCompiled(['h2' => '//h2']);