jbbcode/jbbcode

PHP 5.3 编写的轻量级但可扩展的 BBCode 解析器。

v1.4.2 2020-06-19 16:09 UTC

This package is auto-updated.

Last update: 2024-09-21 19:50:52 UTC


README

GitHub release Software License Build Status

jBBCode 是用 php 5.3 编写的 bbcode 解析器。它相对轻量,且在解析 bbcode 时不依赖昂贵的正则表达式。

文档

有关完整文档和示例,请访问 jbbcode.com

基本示例

jBBCode 包含一些可选的默认 bbcode 定义,可以通过 DefaultCodeDefinitionSet 类加载。以下是一个简单示例,展示如何使用这些代码将 bbcode 字符串转换为 html。

<?php
require_once "/path/to/jbbcode/Parser.php";

$parser = new JBBCode\Parser();
$parser->addCodeDefinitionSet(new JBBCode\DefaultCodeDefinitionSet());

$text = "The default codes include: [b]bold[/b], [i]italics[/i], [u]underlining[/u], ";
$text .= "[url=http://jbbcode.com]links[/url], [color=red]color![/color] and more.";

$parser->parse($text);

print $parser->getAsHtml();

Composer

您可以通过 composer 加载 jBBCode。在您的 composer.json 文件中

"require": {
    "jbbcode/jbbcode": "1.3.*"
}

在您的 PHP 文件中

require 'vendor/autoloader.php';

$parser = new JBBCode\Parser();

贡献

我非常乐意帮助维护 jBBCode。查看 开放性问题 以获取需要完成的工作的想法。在提交 pull request 之前,请确保所有单元测试仍然通过。

运行单元测试

要运行单元测试,请确保已安装 phpunit,或者通过 composer 开发依赖项安装它。然后从项目目录中运行 phpunit。如果您正在添加新功能,编写额外的单元测试是个好主意。

许可协议

本项目采用 MIT 许可协议。请参阅 许可文件 以获取详细信息。