README

DiDOM - 简单快速的HTML解析器。

内容

• 安装
• 快速入门
• 创建新文档
• 搜索元素
• 验证元素是否存在
• 支持的选择器
• 输出
• 创建新元素
• 获取元素名称
• 获取父元素
• 获取同级元素
• 获取子元素
• 获取文档
• 处理元素属性
• 比较元素
• 添加子元素
• 替换元素
• 删除元素
• 处理缓存
• 杂项
• 与其他解析器的比较

安装

要安装DiDOM，请运行以下命令

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允许以多种方式加载HTML

使用构造函数

// the first parameter is a string with HTML
$document = new Document($html);

// or URL
$document = new Document('http://www.example.com/', true);

第二个参数指定是否需要加载文件。默认为false。

使用单独的方法

$document = new Document();

$document->loadHtml($html);

$document->loadHtmlFile('http://www.example.com/');

有两个方法可用于加载XML：loadXml和loadXmlFile。

这些方法接受额外的选项

$document->loadHtml($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);

搜索元素

DiDOM接受CSS选择器或XPath作为搜索的表达式。您需要将路径表达式作为第一个参数，并在第二个参数中指定其类型（默认类型为Query::TYPE_CSS）

使用find()方法

use DiDom\Document;
use DiDom\Query;

...

// CSS selector
$posts = $document->find('.post');

// XPath
$posts = $document->find("//div[contains(@class, 'post')]", Query::TYPE_XPATH);

如果找到匹配给定表达式的元素，则方法返回一个包含DiDom\Element实例的数组，否则返回一个空数组。您也可以获取一个包含DOMElement对象的数组。要获取此数组，请将false作为第三个参数传递。

使用魔法方法__invoke()

$posts = $document('.post');

使用xpath()方法

$posts = $document->xpath("//*[contains(concat(' ', normalize-space(@class), ' '), ' post ')]");

您可以在元素内部进行搜索

echo $document->find('nav')[0]->first('ul.menu')->xpath('//li')[0]->text();

验证元素是否存在

要验证元素是否存在，请使用has()方法

if ($document->has('.post')) {
    // code
}

如果您需要先检查元素是否存在，然后获取它

if ($document->has('.post')) {
    $elements = $document->find('.post');
    // code
}

但这样会更快

if (count($elements = $document->find('.post')) > 0) {
    // code
}

因为在第一种情况下，它进行了两次请求。

支持的选择器

DiDom支持以下搜索

• 标签
• 类、ID、属性名称和值
• 伪类
  • first-, last-, nth-child
  • 空和非空
  • 包含
  • 有

// 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)');

输出

获取HTML

使用html()方法

$posts = $document->find('.post');

echo $posts[0]->html();

转换为字符串

$html = (string) $posts[0];

格式化HTML输出

$html = $document->format()->html();

元素没有format()方法，因此如果您需要输出元素的格式化HTML，则必须首先将其转换为文档

$html = $element->toDocument()->format()->html();

内部HTML

$innerHtml = $element->innerHtml();

文档没有innerHtml()方法，因此，如果您需要获取文档的内部HTML，则必须首先将其转换为元素

$innerHtml = $document->toElement()->innerHtml();

获取XML

echo $document->xml();

echo $document->first('book')->xml();

获取内容

$posts = $document->find('.post');

echo $posts[0]->text();

创建新元素

创建类的实例

use DiDom\Element;

$element = new Element('span', 'Hello');

// Outputs "<span>Hello</span>"
echo $element->html();

第一个参数是属性名称，第二个参数是其值（可选），第三个参数是元素属性（可选）。

创建具有属性元素的示例

$attributes = ['name' => 'description', 'placeholder' => 'Enter description of item'];

$element = new Element('textarea', 'Text', $attributes);

可以从DOMElement类的实例创建元素

use DiDom\Element;
use DOMElement;

$domElement = new DOMElement('span', 'Hello');

$element = new Element($domElement);

使用createElement方法

$document = new Document($html);

$element = $document->createElement('span', 'Hello');

获取元素名称

$element->tag;

获取父元素

$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 = '<div>Foo<span>Bar</span><!--Baz--></div>';

$document = new Document($html);

$div = $document->first('div');

// element node (DOMElement)
// string(3) "Bar"
var_dump($div->child(1)->text());

// text node (DOMText)
// string(3) "Foo"
var_dump($div->firstChild()->text());

// comment node (DOMComment)
// string(3) "Baz"
var_dump($div->lastChild()->text());

// array(3) { ... }
var_dump($div->children());

获取文档

$document = new Document($html);

$element = $document->find('input[name=email]')[0];

$document2 = $element->getDocument();

// bool(true)
var_dump($document->is($document2));

处理元素属性

创建/更新属性

使用setAttribute方法

$element->setAttribute('name', 'username');

使用attr方法

$element->attr('name', 'username');

使用魔法方法__set

$element->name = 'username';

获取属性值

使用getAttribute方法

$username = $element->getAttribute('value');

使用attr方法

$username = $element->attr('value');

使用魔法方法__get

$username = $element->name;

如果找不到属性，则返回null。

验证属性是否存在

使用hasAttribute方法

if ($element->hasAttribute('name')) {
    // code
}

使用魔法方法__isset

if (isset($element->name)) {
    // code
}

删除属性

使用removeAttribute方法

$element->removeAttribute('name');

使用魔法方法__unset

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();

处理缓存

缓存是从CSS转换而来的XPath表达式数组

从缓存中获取

use DiDom\Query;

...

$xpath    = Query::compile('h2');
$compiled = Query::getCompiled();

// array('h2' => '//h2')
var_dump($compiled);

设置缓存

Query::setCompiled(['h2' => '//h2']);

杂项

preserveWhiteSpace

默认情况下，空白保留功能是禁用的。

您可以在加载文档之前启用 preserveWhiteSpace 选项。

$document = new Document();

$document->preserveWhiteSpace();

$document->loadXml($xml);

count

count () 方法用于计算匹配选择器的子元素数量。

// prints the number of links in the document
echo $document->count('a');

// prints the number of items in the list
echo $document->first('ul')->count('li');

matches

如果节点匹配选择器，则返回 true。

$element->matches('div#content');

// strict match
// returns true if the element is a div with id equals content and nothing else
// if the element has any other attributes the method returns false
$element->matches('div#content', true);

isElementNode

检查一个元素是否是元素（DOMElement）。

$element->isElementNode();

isTextNode

检查一个元素是否是文本节点（DOMText）。

$element->isTextNode();

isCommentNode

检查元素是否是注释（DOMComment）。

$element->isCommentNode();

与其他解析器的比较

与其他解析器的比较