README

此包允许您从Storyblok的richtext字段获取HTML字符串。

安装Storyblok PHP Richtext Renderer

您可以通过composer安装Storyblok PHP Richtext Renderer。Storyblok PHP Richtext Renderer需要PHP版本7.3到8.2。建议使用一个积极支持版本的PHP（8.1和8.2）。

如果您想安装Storyblok PHP Richtext Renderer的稳定版本，您可以启动

composer require storyblok/richtext-resolver

如果您想安装当前的开发版本，您可以添加版本dev-master

composer require storyblok/richtext-resolver dev-master

要执行上述命令，您需要在您的开发环境中安装composer。如果您需要安装Composer，可以遵循官方Composer文档

在GNU Linux / Unix / macOS上安装Composer
在Windows上安装Composer

我们建议使用最新的PHP版本。

composer require storyblok/richtext-resolver dev-master

用法

实例化Resolver类

use Storyblok\RichtextRender\Resolver;

$resolver = new Resolver();

使用函数render()从您的richtext字段获取HTML字符串。

// previous code...

// Note that in php our objects use multidimensional array notation
$data = [
  "type" => "doc",
  "content" => [
    [
      "type" => "horizontal_rule"
    ]
  ]
];

$resolver->render($data) # renders a html string: '<hr />'

如何为解析器定义自定义模式？

复制默认模式storyblok-php-richtext-renderer/src/Schema.php并添加您自己的模式作为Richtext类的参数。

$resolver = new Resolver($my_custom_schema);

测试

我们使用PHPUnit进行测试。您可以通过以下composer任务运行测试

composer run test

如果您想生成覆盖率报告，您可以启动

composer run test-coverage

您将在coverage/目录中找到HTML报告。

代码风格指南

为了保持一致性，我们使用PHP Coding Standards Fixer工具来检查和修复代码，以符合标准。

要检查代码，您可以执行

composer run codestyle-check

如果您想自动修复代码以符合标准

composer run codestyle-fix

如果您想执行修复和测试覆盖率

composer run all-check

贡献

在Github上Fork我

storyblok / richtext-resolver

维护者

详细信息

README

安装Storyblok PHP Richtext Renderer

用法

如何为解析器定义自定义模式？

测试

代码风格指南

贡献