elgentos/prismic-php-sdk

Prismic 的 PHP 开发套件(分支版)


README

alt text

Prismic 的 PHP 开发套件

入门指南

为您的项目安装套件

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

使用 Composer 安装

$ composer require elgentos/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 辅助程序使用方法

在这些示例中,我们有一个 $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,而不适用于您的命令行。检查您的操作系统如何工作以使其发生,如果它涉及更改 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 License,版本 2.0(“许可证”);除非适用法律要求或经书面同意,否则不得使用此项目除遵守许可证外。您可以在 https://apache.ac.cn/licenses/LICENSE-2.0 获取许可证副本。

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