friendsoftypo3headless / headless-bootstrap-package
此扩展提供与 bootstrap_package 的集成,以便以 JSON 格式输出 TYPO3 的内容。
Requires
- php: ^8.1
- bk2k/bootstrap-package: ^13.0 || ^14.0
- friendsoftypo3/headless: ^4.2
- typo3/cms-core: ^12.4
Requires (Dev)
- ext-json: *
- ergebnis/composer-normalize: ^2.15.0
- friendsofphp/php-cs-fixer: ^3.1
- helmich/typo3-typoscript-lint: ^3.0
- justinrainbow/json-schema: ^5.2
- phpspec/prophecy-phpunit: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.9.2
- phpunit/phpcov: ^8.2
- saschaegerer/phpstan-typo3: ^1.8.2
- typo3/coding-standards: ^0.5.0
- typo3/testing-framework: ^7
README
TYPO3 扩展 "headless_bootstrap_package" - 提供EXT:bootstrap_package内容的TypoScript定义,以生成正确的JSON输出
此扩展为 EXT:bootstrap_package 与 EXT:headless 提供集成。
它为 EXT:bootstrap_packages 的所有 ContentElements 提供TypoScript渲染定义,以便将它们作为正确的JSON输出。
要求
此扩展需要
- TYPO3 至少版本 11.5
- EXT:headless 至少版本 3.0.3
- EXT:bk2k/bootstrap-package 至少版本 12.0
TYPO3 安装
使用 composer 安装扩展
composer require friendsoftypo3headless/headless-bootstrap-package
然后,包括 TypoScript 模板,您就可以开始使用了。
重要:不要包含 EXT: bootstrap_package 提供的 Setup/Constants,因为它们会与 EXT:headless 页面配置冲突。
相反,请包含提供的 "Headless Boostrap Package: Boostrap Package Constants" TypoScript 配置,以便访问 EXT: bootstrap_package 常量。
此扩展在每个 JSON 页面响应中添加一个 "bootstrapPackage" 键,包含 EXT:bootstrap_package 常量/config:
它还将 page.meta 常量合并到 page.meta JSON 数组中:
测试
此扩展附带一个 phpunit 测试套件,包含所有内容元素的函数测试。
要运行测试,请使用提供的 composer 脚本
composer ci:test
致谢
特别感谢 TRIXIE Heimtierbedarf GmbH & Co. KG,它资助了此扩展的开发。