chaseconey/laravel-storyblok

Storyblok API的Laravel封装,为Laravel开发者提供熟悉的使用体验

资助包维护!
Ko Fi

2.5.2 2021-01-22 15:23 UTC

README

Latest Version on Packagist Build Quality Score Total Downloads ko-fi Twitter

此包允许您使用出色的Storyblok无头CMS与惊人的Laravel PHP框架。它旨在让Laravel开发者感到自然,成为生态系统的一部分,同时将Storyblok的API JSON响应转换为强大功能,无需额外努力。

主要功能

  • 将Storyblok的页面映射到PHP页面类,提供对嵌套内容(块)和SEO、OpenGraph等元数据的访问。
  • 每个Storyblok组件都会自动转换为PHP类,使用简单的命名约定 - 只需匹配类和组件名称即可。
  • 新功能!将组件中的所有字段转换为Field PHP类,允许您操作其数据。该包自动检测常见的类型,如富文本字段、资产和Markdown。
  • 资产字段转换为Assets类,允许您按要求操作它们。
  • 块和字段知道它们相对于其祖先的位置,可以创建CSS类来帮助您的样式设计。
  • JSON数据结构得到保留,但功能更强大,使您可以在视图中轻松循环。
  • 通过包含一个视图并在Blade中对每个块调用一个方法,可以轻松链接到Storyblok可视化编辑器。
  • 请求内容“文件夹”,如文章列表或团队人员。
  • 感觉像Laravel - 使用日期转换和访问器与模型完全一样。
  • 更丰富的字体排版,内置PHP Typography。

文档

阅读完整文档

为文档做出贡献

未来计划

  • 更多内容转换
  • 更好地支持更多组件类型
  • 更好的图像转换
  • 缓存昂贵的转换
  • 等等...

测试

测试大多是最新的,并覆盖了大部分代码。一些需要访问Storyblok API的区域未进行测试。如果您有模拟API的经验,请随时贡献测试。

更新日志

查看此处

贡献

请随时帮助扩展和改进此项目。该包使用Git Flow,但您可以将拉取请求提交到develop分支。

安全性

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

致谢

许可证

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

Laravel包模板

此包是使用Laravel包模板生成的。