README

版本 1.7.0

PHPHtmlParser 是一个简单、灵活的 HTML 解析器，允许您使用任何 CSS 选择器选择标签，就像 jQuery 一样。目标是帮助开发需要快速、简单抓取 HTML 的工具，无论其是否有效！该项目最初由 sunra/php-simple-html-dom-parser 支持，但支持似乎已停止，因此该项目是我对他之前工作的改编。

安装

此软件包可在 packagist 上找到，并建议使用 composer 加载。我们支持 php 5.6、7.0 和 hhvm 2.3。

用法

您可以在测试目录中找到许多如何使用 DOM 解析器及其任何部分（您可能永远不会接触）的示例。这些测试使用 PHPUnit 进行，非常小巧，每个只有几行，是一个很好的起点。考虑到这一点，我仍将展示一些如何使用此软件包的示例。以下是一个非常简单的示例。

// 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"

上面的示例将输出 "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/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 类进行处理。它还展示了您可以使用节点执行的一些操作，但这不是节点可用的方法详尽列表。

另外，您始终可以使用 load() 方法加载文件。它将尝试使用 file_exists 查找文件，如果成功，将为您调用 loadFromFile()。同样适用于 URL 和 loadFromUrl() 方法。

加载 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->load('http://google.com');
$html = $dom->outerHtml; // same result as the first example

使 loadFromUrl 方法值得注意的是 PHPHtmlParser\CurlInterface 参数，一个可选的第二个参数。默认情况下，我们使用 PHPHtmlParser\Curl 类获取 URL 的内容。然而，另一方面，您可以注入自己的 CurlInterface 实现，我们将尝试使用您想要的任何工具/设置来加载 URL，由您决定。

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

只要连接器对象正确实现了 PHPHtmlParser\CurlInterface 接口，它将使用该对象获取 URL 的内容，而不是默认的 PHPHtmlParser\Curl 类。

加载字符串

直接加载字符串，而不在 load() 中进行检查，也易于完成。

// Assuming you installed from Composer:
require "vendor/autoload.php";
use PHPHtmlParser\Dom;

$dom = new Dom;
$dom->loadStr('<html>String</html>', []);
$html = $dom->outerHtml;

如果字符串过长，根据您的文件系统，load()方法可能会抛出警告。如果发生这种情况，您可以直接调用上述方法来绕过load()方法中的is_file()检查。

选项

您还可以设置解析选项，这将影响解析引擎的行为。您可以使用Dom对象中的setOptions方法设置全局选项数组，或者通过将其作为额外（可选）参数添加到load方法中设置实例特定的选项。

// 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.

目前我们支持7个选项。

严格

严格，默认为false，如果发现html不符合严格规范（所有标签必须有闭合标签，没有没有值的属性等），将抛出StrickException异常。

whitespaceTextNode

whitespaceTextNode选项，默认为true，告诉解析器即使节点的内容为空（仅包含空白）也要保存文本节点。将其设置为false将忽略文档中找到的所有仅包含空白文本节点。

enforceEncoding

enforceEncoding选项，默认为null，将强制使用字符集读取内容并返回该编码的内容。将其设置为null将尝试从给定的字符串内容中确定编码。

cleanupInput

将此设置为true以跳过解析器的整个清理阶段。如果设置为true，则忽略以下3个选项。默认为false。

removeScripts

将此设置为false以跳过从文档体中移除脚本标签。这可能会产生不利影响。默认为true。

removeStyles

将此设置为false以跳过从文档体中移除样式标签。这可能会产生不利影响。默认为true。

preserveLineBreaks

如果设置为true，则保留换行符。如果设置为false，则将换行符作为输入清理过程的一部分进行清理。默认为false。

静态外观

您还可以为Dom对象安装静态外观。

PHPHtmlParser\StaticDom::mount();

Dom::load('tests/big.hmtl');
$objects = Dom::find('.content-border');

上述PHP块执行与第一个示例相同的查找和加载，但它使用的是静态外观，该外观支持Dom对象中找到的所有公共方法。

修改Dom

您始终可以修改由任何加载方法创建的dom。要更改任何节点的属性，只需调用setAttribute方法。

$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"

您还可以直接获取PHPHtmlParser\Dom\Tag类，并根据您的需要对其进行操作。

$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"

还有可能从树中删除节点。只需在任意节点上调用delete方法即可将其从树中删除。需要注意的是，在从`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];
$a->delete();
unset($a);
echo $dom; // '<div class="all"><p>Hey bro, <br /> :)</p></div>');

a2design-inc / php-html-parser

维护者

详细信息