sunland-aps/prismic-php-sdk

Prismic 的 PHP 开发工具包

v1.0.1 2022-09-02 12:03 UTC

This package is auto-updated.

Last update: 2024-09-30 01:52:13 UTC


README

alt text

Prismic 的 PHP 开发工具包

入门指南

为您的项目安装工具包

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

使用 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');

此工具包支持 PHP 版本 >= 7.1。

由于依赖事件调度器,此库与 Symfony 版本 2.8 及更高版本兼容。对于 Symfony 2.7 项目,请使用版本 2.0.3。

DOM 辅助工具使用

在这些示例中,我们有一个与获取的 Prismic 文档对应的 $doc 变量。我们还有一个包含功能链接解析器的 $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

测试

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

如果您发现现有代码未得到良好测试,并希望使其更好,我们将非常感激;但您应该在单独的分支和单独的拉取请求上对其进行文档化。

运行测试

$ ./vendor/bin/phpunit

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

  • 通过运行 php -i | grep apc 检查您的 APC 是否为命令行启用;如果没有输出显示,那么您安装并启用的 APC 扩展可能只针对 Apache 启用,而不是针对您的命令行。检查您的操作系统如何工作以实现这一点,如果涉及到更改 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(“许可证”);除非适用法律要求或经书面同意,否则不得使用本项目,除非遵守许可证。您可以在 https://apache.ac.cn/licenses/LICENSE-2.0 获取许可证副本。

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