zumba/prismic-sdk

非官方Prismic.io SDK


README

本仓库/包是非官方的Prismic.io SDK版本。它支持PHP的新版本,并应用了错误修复。

入门

为您的项目安装套件

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

使用Composer安装

$ composer require zumba/prismic-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.2。

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

DOM助手用法

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

链接

<?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 License,版本2.0("许可证");除非遵守许可证,否则不得使用本项目。您可以在https://apache.ac.cn/licenses/LICENSE-2.0获取许可证的副本。

除非适用法律要求或书面同意,否则在许可证下分发的软件按“现状”分发,不提供任何类型的保证或条件,无论是明示的还是默示的。有关许可证的权限和限制的具体语言,请参阅许可证。