natlibfi / php-html-parser
HTML DOM 解析器。允许您操作 HTML。使用选择器在 HTML 页面上找到标签,就像 jQuery 一样。
Requires
- php: >=7.4
- ext-curl: *
- ext-mbstring: *
- ext-zlib: *
- guzzlehttp/guzzle: ^7.5.0
- guzzlehttp/psr7: ^2.4.1
- myclabs/php-enum: ^1.8.4
- paquettg/string-encode: ~1.0.0
- php-http/httplug: ^2.3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.11.0
- infection/infection: ^0.26.6
- mockery/mockery: ^1.2
- phan/phan: ^5.4.1
- phpunit/phpunit: ^9.5.25
README
由 paquettg/php-html-parser 分支而来
PHPHtmlParser 是一个简单、灵活的 HTML 解析器,允许您使用任何 CSS 选择器选择标签,就像 jQuery 一样。目标是协助开发需要快速、轻松抓取 HTML 的工具,无论其是否有效!
安装
使用 composer 安装最新版本。
$ composer require natlibfi/php-html-parser
此软件包可在 packagist 上找到,最好使用 composer 加载。我们支持 php 7.4、8.0 和 8.1。
基本用法
您可以在测试目录中找到许多如何使用 DOM 解析器和其任何部分(您可能永远不会触碰)的示例。测试是用 PHPUnit 进行的,非常小,每个只有几行,是一个很好的起点。鉴于这一点,我仍然会展示一些如何使用该软件包的示例。以下是一个使用该软件包的非常简单的示例。
// Assuming you installed from Composer: require "vendor/autoload.php"; use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<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"
上面的代码将输出 "点击这里"。简单,不是吗?从 DOM 中获取相同结果的方式有很多,比如 $dom->getElementsbyTag('a')[0]
或 $dom->find('a', 0)
,这些都可在测试或代码本身中找到。
加载文件
您还可以无缝地将文件加载到 DOM 中,而不是字符串,这更方便,这也是我期望大多数开发人员加载 HTML 的方式。以下示例来自我们的测试,并使用了在那里找到的 "big.html" 文件。
// 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(); }
此示例从 "big.html" 加载 HTML,这是一个在线找到的真实页面,并获取所有 content-border 类以处理。它还展示了一些您可以使用节点进行的事情,但不是节点具有的所有方法的详尽列表。
加载 URL
加载 URL 的方式与从文件加载 HTML 的方式非常相似。
// 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->loadFromUrl('http://google.com'); $html = $dom->outerHtml; // same result as the first example
默认情况下,loadFromUrl 将使用 \Psr\Http\Client\ClientInterface
的实现来完成 HTTP 请求,并使用 \Psr\Http\Message\RequestInterface
的默认实现来创建请求体。您可以在使用 loadFromUrl 时轻松实现自己的客户端或请求版本以使用自定义 HTTP 连接。
// Assuming you installed from Composer: require "vendor/autoload.php"; use PHPHtmlParser\Dom; use App\Services\MyClient; $dom = new Dom; $dom->loadFromUrl('http://google.com', null, new MyClient()); $html = $dom->outerHtml;
只要客户端对象正确实现了接口,它就会使用该对象获取 URL 的内容。
加载字符串
直接加载字符串也很容易。
// Assuming you installed from Composer: require "vendor/autoload.php"; use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<html>String</html>'); $html = $dom->outerHtml;
选项
您还可以设置影响解析器行为的解析选项。您可以使用 Dom
对象中的 setOptions
方法设置全局选项数组,或通过将其添加到 load
方法的额外(可选)参数中设置实例特定选项。
// Assuming you installed from Composer: require "vendor/autoload.php"; use PHPHtmlParser\Dom; use PHPHtmlParser\Options; $dom = new Dom; $dom->setOptions( // this is set as the global option level. (new Options()) ->setStrict(true) ); $dom->loadFromUrl('http://google.com', (new Options())->setWhitespaceTextNode(false) // only applies to this load. ); $dom->loadFromUrl('http://gmail.com'); // will not have whitespaceTextNode set to false.
目前我们支持 12 个选项。
严格
默认情况下为 false 的严格选项会在发现 HTML 严格不合规时(所有标签必须有关闭标签,没有属性的属性没有值等)抛出 StrickException
。
whitespaceTextNode
默认情况下为 true 的 whitespaceTextNode 选项告诉解析器保存文本节点,即使节点的内容为空(只有空白)。将其设置为 false 将忽略文档中找到的所有只有空白文本的节点。
enforceEncoding
enforceEncoding选项默认为null,将强制使用一个字符集来读取内容并在该编码下返回内容。将其设置为null将触发从给定字符串的内容中尝试推断编码。
cleanupInput
将此设置为false
以跳过解析器的整个清理阶段。如果设置为true,则将忽略下三个选项。默认为true
。
removeScripts
将此设置为false
以跳过从文档体中删除脚本标签。这可能会产生不利影响。默认为true
。
removeStyles
将此设置为false
以跳过从文档体中删除样式标签。这可能会产生不利影响。默认为true
。
preserveLineBreaks
如果设置为true
,则保留换行符。如果设置为false
,则换行符作为输入清理过程的一部分进行清理。默认为false
。
removeDoubleSpace
如果您想保留文本节点内的空白,则将此设置为false
。默认为true
。
removeSmartyScripts
如果您想保留HTML内容中找到的smarty脚本,则将此设置为false
。默认为true
。
htmlSpecialCharsDecode
默认情况下,此选项设置为false
。将其设置为true
将应用php函数htmlspecialchars_decode
到所有属性值和文本节点。
selfClosing
此选项包含所有自闭合标签的数组。这些标签必须是自闭合的,如果启用了严格模式,则解析器将强制它们自闭合。您可以使用任何其他可以作为自闭合标签使用的标签来更新此列表。您还可以从该数组中删除标签或完全清除它。
noSlash
此选项包含所有不能自闭合的标签的数组。列表最初为空,但您可以添加所需的项目。
静态外观
您还可以为Dom对象安装静态外观。
PHPHtmlParser\StaticDom::mount(); Dom::loadFromFile('tests/big.hmtl'); $objects = Dom::find('.content-border');
上面的php块执行与第一个示例相同的查找和加载,但它使用的是静态外观,该外观支持Dom对象中找到的所有公共方法。
修改Dom
您可以修改由任何加载方法创建的dom。要更改任何节点的属性,只需调用setAttribute
方法。
use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<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"
您还可以直接获取PHPHtmlParser\Dom\Tag
类,并按需对其进行操作。
use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>'); /** @var Dom\Node\AbstractNode $a */ $a = $dom->find('a')[0]; $tag = $a->getTag(); $tag->setAttribute('class', 'foo'); echo $a->getAttribute('class'); // "foo"
您还可以从树中删除节点。只需在任意节点上调用delete
方法即可将其从树中删除。请注意,删除节点后,您应该在`DOM`中取消设置该节点,否则它仍会占用内存,直到它被取消设置。
use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>'); /** @var Dom\Node\AbstractNode $a */ $a = $dom->find('a')[0]; $a->delete(); unset($a); echo $dom; // '<div class="all"><p>Hey bro, <br /> :)</p></div>');
您可以轻松修改TextNode
对象的文本。请注意,如果您设置了编码,则新文本将使用现有编码进行编码。
use PHPHtmlParser\Dom; $dom = new Dom; $dom->loadStr('<div class="all"><p>Hey bro, <a href="google.com">click here</a><br /> :)</p></div>'); /** @var Dom\Node\InnerNode $a */ $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>'