HTML Purifier 技术文档

1. 安装指南

HTML Purifier 是一个使用 PHP 编写的 HTML 过滤解决方案，它通过独特的白名单和积极解析的组合，确保不仅能够阻止 XSS 攻击，而且生成的 HTML 符合标准。

通过 Composer 安装

要使用 Composer 管理依赖项，可以在项目根目录下运行以下命令：

$ composer require ezyang/htmlpurifier

确保已经安装了 Composer。如果没有安装 Composer，可以访问 Composer 官网 进行下载和安装。

2. 项目的使用说明

HTML Purifier 适用于来自不可信源且需要 CSS 和完整标签集的丰富格式文档。此库可以配置为接受更严格的标签集，但效率可能不如更简单的解析器。然而，它可以确保工作正确完成，这在某些情况下可能更为重要。

快速入门

以下是一个简单的使用示例：

<?php
// 引入 HTML Purifier 类
require_once 'path/to/htmlpurifier/HTMLPurifier.includes.php';

// 配置 HTML Purifier
$config = HTMLPurifier_Config::createDefault();

// 创建 HTML Purifier 实例
$purifier = new HTMLPurifier($config);

// 清理 HTML 内容
$clean_html = $purifier->purify($dirty_html);
?>

其中 $dirty_html 是需要清理的 HTML 内容。

配置选项

HTML Purifier 提供了丰富的配置选项，可以在创建配置对象时进行设置。

$config = HTMLPurifier_Config::createDefault();
$config->set('Core', 'Encoder', 'UTF-8');
// 更多配置...

3. 项目API使用文档

HTML Purifier 的 API 文档详细介绍了所有可用的类、方法和配置选项。以下是一些关键类和方法的简要说明：

• HTMLPurifier: 主要的清理类。
• HTMLPurifier_Config: 用于配置 HTML Purifier 的类。
• HTMLPurifier_Config::createDefault(): 创建默认配置的方法。

更多详细信息，请参考项目自带的 docs/ 目录中的开发文档。

4. 项目安装方式

HTML Purifier 可以通过以下方式安装：

通过 Composer

如前所述，可以通过 Composer 安装 HTML Purifier。

$ composer require ezyang/htmlpurifier

手动安装

如果没有使用 Composer，也可以手动下载 HTML Purifier 的源代码。可以从其 GitHub 仓库 下载最新版本，然后将其放置到项目中的合适位置，并引入相应的文件。

请确保遵循项目中的 INSTALL 指南，以获取更多关于手动安装的详细信息。

以上就是 HTML Purifier 的技术文档，希望对您使用和理解该项目有所帮助。