README

一个用于解析 BBCode 标签的 CakePHP 插件

通过 composer 安装

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。对于现有应用程序，您可以将以下内容添加到您的 composer.json 文件中

"require": {
    "bnware/cakephp-bbcode": "*"
}

然后运行 php composer.phar update

在您的 config\bootstrap.php 文件中

Plugin::load('BBCode', ['bootstrap' => true]);

使用国际化与本地化

所有错误消息都可以本地化。您只需使用 src/Locale/BBCode.pot 中的模板文件。

自定义标签渲染

标签是通过视图单元渲染的。您可以通过定义自己的视图单元来自定义渲染。单元必须包含每个标签的一个动作。动作的名称必须是标签名称，可选地以下划线开头。

您可以通过从预定义的单元继承或定义自己的标签集来扩展预定义的标签。要使用一些渲染工具，您可以使用 TagRendererTrait。

要将要使用的视图单元配置到您的配置中，请添加 BBCode.renderCell。值可以是插件语法中的类名或完全限定的类名。

调用解析器

您可以通过使用 `php BBCodeHelper::render($bbCode)` 方法在视图中使用解析器。您只需将 BBCodeHelper 添加到您的控制器中

$this->helpers[] = 'BBCode.BBCode';

您还可以使用 BBCodeValidator 来检查用户输入是否是有效的 BBCode 语法。您只需将其定义为验证提供程序，并使用此提供程序定义一个验证规则

$validator->provider('BBCode', 'BBCode\Validation\BBCodeValidator');  
$validator->add('<field>', '<name>', ['provider' => 'BBCode', 'rule' => 'validate']);