aratech/kontentai

用于封装 kontentai PHP SDK 的轻量级包

v0.9.56 2023-10-10 12:55 UTC

This package is auto-updated.

Last update: 2024-09-10 15:04:55 UTC


README

摘要

这是一个简单的 包装类,用于访问由 Kontent.ai 团队提供的现有 Delivery 客户端

开发者

Ammar JliesJimmy Jradeh 开发。

安装过程

在安装此包之前,您必须有一个 Laravel 应用程序。在安装 Laravel 应用程序后,您可以运行

composer require aratech/kontentai

或者调整您的 composer.json 文件

{
    "require": {
        "aratech/kontentai": "^0.7.0"
    }
}

创建 Kontent-ai 客户端

创建 Kontent.ai 客户端 简单易行,首先将您的 Kontent.ai 项目密钥添加到 .env 文件中,并命名为 KONTENT_AI_KEY

KONTENT_AI_KEY = "Put Your Project Key Here"

现在,您可以创建一个 Kontent.ai 客户端并将其分配给一个变量(以下示例中的 $app)

use Aratech\Kontentai;

$app = Kontentai::createClient();

使用我们的查询解决方案

要从您的 Kontent.ai 项目查询一个项,只需使用 -> 操作符

$result = $app->about_us;

如果您想查询多个项,可以将查询过程视为使用 Laravel 内置查询构建器类进行查询

$app->where("name", "article");

返回类型是 Kontentai 对象(与变量 $app 相同)。

因此,您可以在 $app 客户端上链尽可能多的方法,完成后只需使用 fetch 函数获取结果

$results = $app->language('es-ES')->where("name", "article")->fetch();

此处返回的类型是包含查询返回的所有项的 Laravel 集合。

我们可以做的 一个特殊用例 是,在不使用任何链式方法的情况下使用 fetch 方法

$results = $app->fetch();

这将返回您 Kontent.ai 项目中所有可用的项。

您还可以使用 Kontent-ai 提供的 DeliveryClient 中已构建的方法,并使用我们提供的方法将它们链接起来

$results = $app->language('es-ES')->where("name", "article")->orderAsc('elements.product_name')->limit(10)->fetch();

默认情况下,在调用 fetch() 方法后,链式方法将被清除,但您也可以通过在 app 对象上调用 clearQuery() 方法来手动清除它们

$results = $app->clearQuery();

如果您想获取默认 Kontent.ai 客户端的实例,可以使用 getClient() 方法

$client = $app->getClient();

可用方法

where($key, $value) find($id)

这个类的想法是什么?

想法是提供一个方法,可以像使用 Laravel 内置查询构建器类一样在方法之间链式调用。