prismic/php-sdk

Prismic 的 PHP 开发套件


README

Github Actions CI

Prismic 的 PHP 开发套件

入门

为您的项目安装套件

首先,安装 APCu 以启用默认的内置缓存支持。

使用 Composer 安装

$ composer require prismic/php-sdk

使用方法

包含依赖项

<?php
include_once __DIR__.'/../vendor/autoload.php';

use Prismic\Api;

然后调用 API

<?php
$api = Api::get('https://your-repo-name.prismic.io/api/v2');
$doc = $api->getByUID('get-started-type', 'get-started');

此套件支持 PHP 版本 >= 8.0

DOM 辅助函数使用

在这些示例中,我们有一个 $doc 变量对应于获取的 Prismic 文档。我们还有一个 $linkResolver 变量,它包含功能链接解析器,阅读我们的文档以了解更多关于链接解析的信息

链接

<?php
use Prismic\Dom\Link;

echo Link::asUrl($doc->data->link, $linkResolver);

富文本

<?php
use Prismic\Dom\RichText;

echo RichText::asText($doc->data->title);
echo RichText::asHtml($doc->data->description, $linkResolver);

日期

<?php
use Prismic\Dom\Date;

$date = Date::asDate($doc->data->date);
echo $date->format('Y-m-d H:i:s');

更多信息

在本地安装套件

克隆此 GitHub 仓库,然后如果您还没有,安装 Composer 并运行

$ composer install

测试

请为任何错误修复或新功能编写测试。

如果您发现现有代码未经过最佳测试并且希望使其更好,我们将非常感激;但您应该在其自己的分支和其自己的 pull request 中记录它。

运行测试的命令

$ ./vendor/bin/phpunit

套件的某些测试检查建立在 APC 之上的内容,需要 APC 在命令行中工作。如果您已安装并启用了 APC,但您的缓存测试未通过

  • 通过运行 php -i | grep apc 检查您的 APC 是否为命令行启用;如果没有输出显示,那么您安装并启用的 APC 扩展可能仅对 apache 启用,而不适用于您的命令行。检查您的 OS 如何工作以实现这一点,如果它涉及更改 php.ini 文件,请确保它是正确的 php.ini(您可能有一个用于 apache,一个用于命令行)
  • 如果 APC 对命令行已启用,但测试仍然失败,请确保您的 apc.enable_cli(您可以在 php -i | grep apc 的输出中看到)是 'On'。如果不是,请在 php.ini 的末尾添加此行:apc.enable_cli = 1。确保它是正确的 php.ini(您可能有一个用于 apache,一个用于命令行)

许可

此软件根据以下 Apache 2 许可证进行许可。

版权 2018 Prismic (https://prismic.io).

根据 Apache 许可证版本 2.0(“许可证”);除非适用法律要求或书面同意,否则不得根据许可证使用本项目。您可以在 http://www.apache.org/licenses/LICENSE-2.0 获取许可证副本。

除非适用法律要求或书面同意,否则根据许可证分发的软件按“原样”基础分发,不提供任何明示或暗示的保证或条件。有关许可证的具体语言规定权限和限制,请参阅许可证。