Sanitizer 项目启动与配置教程

1. 项目的目录结构及介绍

Sanitizer 是一个用于清理和消毒HTML内容的开源项目。以下是项目的目录结构及各部分功能的简要介绍：

Sanitizer/
│
├── README.md         # 项目说明文件
├── composer.json     # PHP 依赖配置文件
├── composer.lock     # PHP 依赖锁定文件
├── .gitignore        # Git 忽略文件列表
│
├── src/              # 源代码目录
│   ├── Sanitizer.php # Sanitizer 类文件
│   └── tests/        # 单元测试目录
│
└── demo/             # 示例文件目录

• README.md: 项目说明文件，包含项目的简介、安装指南和使用说明。
• composer.json: PHP 项目的依赖配置文件，用于定义项目依赖的库和组件。
• composer.lock: 记录项目的确切依赖版本，确保项目在不同环境中的一致性。
• .gitignore: 指定在Git版本控制中应忽略的文件和目录。
• src/: 源代码目录，包含项目的核心实现。
  • Sanitizer.php: Sanitizer类的定义，提供HTML清理功能。
  • tests/: 单元测试目录，用于确保代码质量和功能正确性。
• demo/: 示例文件目录，包含如何使用Sanitizer的示例代码。

2. 项目的启动文件介绍

项目的启动主要依赖于PHP环境，以下是启动项目的基本步骤：

1. 确保您的系统中已安装PHP环境。
2. 克隆或下载项目到本地环境。
3. 使用composer install命令安装项目依赖。

由于Sanitizer是一个库，它本身没有直接的可执行入口文件。通常，您需要在自己的项目中引入Sanitizer.php文件，然后创建一个实例来使用它。

require 'path/to/Sanitizer/src/Sanitizer.php';

$sanitizer = new \Waavi\Sanitizer\Sanitizer();

3. 项目的配置文件介绍

Sanitizer 的配置主要通过其类方法进行。在实例化Sanitizer类后，可以使用链式方法调用来配置不同的清理规则。

以下是一个配置示例：

require 'path/to/Sanitizer/src/Sanitizer.php';

$sanitizer = new \Waavi\Sanitizer\Sanitizer();
$configuredSanitizer = $sanitizer
    ->clean(
        // 输入的HTML内容
        $htmlContent,
        // 清理配置
        [
            'elements' => [
                'a' => [
                    'allowed_attributes' => ['href', 'title', 'class'],
                ],
                // 更多配置...
            ],
            // 其他配置...
        ]
    );

在这个示例中，我们创建了一个Sanitizer实例，并配置了允许的HTML元素及其属性。这只是一个基本的配置，Sanitizer支持广泛的配置选项，可以根据您的需求进行定制。有关所有配置选项的详细信息，请参考项目的官方文档。