Purifier 开源项目使用教程

Purifier 开源项目使用教程

PurifierHTMLPurifier for Laravel 5/6/7/8/9/10项目地址:https://gitcode.com/gh_mirrors/pu/Purifier

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

Purifier 项目的目录结构如下：

Purifier/
├── src/
│   ├── Purifier.php
│   ├── ...
├── config/
│   ├── purifier.php
│   ├── ...
├── tests/
│   ├── PurifierTest.php
│   ├── ...
├── README.md
├── composer.json
└── ...

目录结构介绍

• src/: 包含项目的主要源代码文件，其中 Purifier.php 是核心文件。
• config/: 包含项目的配置文件，例如 purifier.php。
• tests/: 包含项目的测试文件，例如 PurifierTest.php。
• README.md: 项目的说明文档。
• composer.json: Composer 依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/Purifier.php。这个文件包含了 Purifier 类的定义，是整个项目运行的入口点。

启动文件内容概览

namespace mewebstudio\Purifier;

class Purifier {
    // 类内容
}

3. 项目的配置文件介绍

项目的配置文件位于 config/purifier.php。这个文件定义了 Purifier 的各种配置选项，包括 HTML 过滤规则、编码设置等。

配置文件内容概览

return [
    'encoding'      => 'UTF-8',
    'finalize'      => true,
    'cachePath'     => storage_path('app/purifier'),
    'cacheFileMode' => 0755,
    'settings'      => [
        'default' => [
            'HTML.Doctype'             => 'HTML 4.01 Transitional',
            'HTML.Allowed'             => 'div,b,strong,i,em,a[href|title],ul,ol,li,p[style],br,span[style],img[width|height|alt|src]',
            'CSS.AllowedProperties'    => 'font,font-size,font-weight,font-style,margin',
            'AutoFormat.AutoParagraph' => true,
            'AutoFormat.RemoveEmpty'   => true,
        ],
        'test'    => [
            'Attr.EnableID' => true,
        ],
    ],
];

配置文件说明

• encoding: 设置字符编码。
• finalize: 是否启用最终处理。
• cachePath: 缓存文件路径。
• cacheFileMode: 缓存文件权限。
• settings: 具体的配置选项，包括默认设置和自定义设置。

以上是 Purifier 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用 Purifier 项目。

PurifierHTMLPurifier for Laravel 5/6/7/8/9/10项目地址:https://gitcode.com/gh_mirrors/pu/Purifier