kevintweber/groundskeeper

此包已被废弃,不再维护。未建议替代包。

Groundskeeper 将清理您的杂草丛生的 HTML。

v0.2 2017-03-12 19:49 UTC

This package is not auto-updated.

Last update: 2020-01-25 01:08:59 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score

Groundskeeper 将清理您的杂草丛生的 HTML。

安装

通过 Composer

$ composer require kevintweber/groundskeeper

用法

以下是一个简单的示例

use Groundskeeper\Groundskeeper;

$groundskeeper = new Groundskeeper(array(
    'output' => 'pretty'
));
$groundskeeper->setLogger($myLogger); // Optional: will log changes to your HTML.

$cleanHtml = $groundskeeper->clean($dirtyHtml);

选项

  • clean-strategy: 描述 HTML 文档将被如何清理。
    • 选项: none, lenient, standard, aggressive;默认: standard
      • none - 不会执行任何清理。
      • lenient - 类似于 standard,除了不会移除任何标记。
      • standard - 输出符合标准 HTML。无法修复的损坏的 HTML 将被移除。
      • aggressive - 类似于 "standard",除了还会移除非标准元素。(待办事项)
  • element-blacklist: 描述将从中移除哪些元素。
    • 选项: 元素列表,以逗号分隔;默认: ``(空列表)
  • indent-spaces: 使用美观输出时缩进的空格数。
    • 选项: 大于或等于 0 的整数;默认: 4
  • output: 描述 HTML 将如何输出。
    • 选项: compact, pretty;默认: compact
      • compact - 将移除元素之间的所有空白,并将 indent-spaces 设置为 0。
      • pretty - 每行一个元素,带有缩进。便于调试。
  • type-blacklist: 描述将从中移除哪些令牌类型。
    • 选项: 以下任何一个的逗号分隔列表: cdata, comment, doctype, element, php, text;默认: cdata,comment

待办事项

  1. 实现 aggressive 清理策略。
  2. pretty 输出应内联某些元素。
  3. 添加移除/清理所有 JS 属性的选项。

变更日志

请参阅 CHANGELOG 以获取最近更改的更多信息。

测试

$ phpunit

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全性

如果您发现任何安全相关的问题,请通过电子邮件 kevintweber@gmail.com 而不是使用问题跟踪器。

鸣谢

许可

MIT 许可证 (MIT)。请参阅 许可文件 以获取更多信息。