搜索northeastern-web / pim-fim-适配器
PIM/FIM 2.0 适配器 Composer 包
Requires
- php: ^8.0
- ext-json: *
- ext-mbstring: *
- contentful/contentful: ^7.0
- illuminate/support: ^11.12
- vlucas/phpdotenv: ^5.6
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-01 14:56:30 UTC
README
PIM/FIM 2.0 适配器 Composer 包 - 用于基于 PHP 和 WordPress 的网站
需求
- PHP 8.0+（服务器上的 PHP 核心）
- ext-json（服务器上的 PHP 扩展）
- ext-mbstring（服务器上的 PHP 扩展）
安装
包安装
- 在您想要集成 PIMFIMAdapter 的项目（您的项目
composer.json所在的位置）中，运行composer require northeastern-web/pim-fim-adapter。 - 在项目根目录中添加 .env 文件（将
.env.example复制到.env文件中），或者在您的 PHP 应用程序的配置（WordPresswp-config.php）中定义常量。
开发安装
- 在项目根目录下运行
cd。 - 在命令行/终端中运行
composer install。 - 在项目根目录中添加 .env 文件（将
.env.example复制到.env文件中），并添加常量。
配置
此包支持使用 PHP Dotenv 包来设置和读取环境变量。如果您的 PHP 项目不使用 Dotenv，请在应用程序的配置中声明变量为常量（使用 define()）。在 WordPress 中，此配置将是 wp-config.php 文件。
PIM
FIM
使用
PiM/FIM 适配器包允许您快速查询 Contentful 的结果，而无需构建复杂的查询或了解内容模型。PIM/FIM 适配器类中的每个响应都返回一个 Contentful 对象，这可以转换为 Laravel 集合、JSON 或其他格式。
您可能看到 test/fim/index.php 和 test/pim/index.php，它们是用于开发和验证或预览每个适配器方法响应的测试文件。
Contentful 适配器
ContentfulAdapter.php 类文件旨在公开通过 Contentful PHP SDK 与 Contentful API 交互的方法。获取条目的每个方法都需要一个 Query 对象作为参数。默认情况下，每个查询将自动解析 1 级深的引用条目。需要通过单独的获取条目调用进行额外的链接解析级别。
以下是 Contentful 适配器中可用方法的列表
PIM
以下是 PIMAdapter 类中可用方法的列表
FIM
以下是 FIMAdapter 类中可用方法的列表
响应
响应是 PHP 数组或 Contentful ResourceArray。使用附加到 ResourceArray 的方法将数据映射到字段。
使用 PIM/FIM 模型将内容类型映射到普通的关联 PHP 数组。
富文本
您可能在 PHP 响应中遇到富文本字段。要转换为 HTML，您可能需要查看 Contentful\RichText\Renderer 类。有一个类可以在模型类中使用来渲染富文本（RendersRichText）。