theplanworks / directus-laravel
用于集成 Laravel 5.4 和 Directus API 的包
1.0.2
2017-03-02 02:22 UTC
Requires
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- orchestra/testbench: ~3.0
- phpunit/phpunit: ~5.7
This package is not auto-updated.
Last update: 2024-09-14 20:45:52 UTC
README
为 Laravel 5 的 Directus API 封装器
此包允许用户轻松消费在 Laravel 应用中由 Directus 无头 CMS 系统提供的 REST API。
安装
使用命令行通过 composer 安装
composer require theplanworks/directus-laravel
在 Laravel 5 中,更新 config/app.php 的 providers 数组以包含服务提供者
thePLAN\DirectusLaravel\DirectusLaravelServiceProvider::class,
配置
默认情况下,该包配置为使用以下配置值,这些值从您的 .env 文件中读取
DIRECTUS_CMS_URL- 您 CMS 实例的基本 URL。DIRECTUS_API_KEY- 由 CMS 生成并与验证请求的有效用户关联的密钥
如果您想使用配置文件,可以通过运行以下命令发布默认配置
php artisan vendor:publish --provider="thePLAN\DirectusLaravel\DirectusLaravelServiceProvider"
这将发布一个配置文件到 config/directus-laravel.php。
用法
要使用 API 封装器,请使用依赖注入来解决
public function __construct(DirectusLaravel $directusAPI) { $this->api = $directusAPI; }
然后您可以执行以下调用
getTableRows
$value = $this->api->getTableRows($table);
其中 $table 是您想访问的 Directus 表的名称。
getTableRow
$value = $this->api->getTableRow($table, $id);
其中 $table 是您想访问的 Directus 表的名称,而 $id 是请求记录的唯一 ID。
getTableRowBySlug
$value = $this->api->getTableRowBySlug($table, $slug)
其中 $table 是您想访问的 Directus 表的名称,而 $slug 是请求记录的唯一 slug 属性。前提条件:表上已创建 slug 字段。
getFile
$this->api->getFile($url);
其中 $url 是您想返回的文件 URL,例如 /storage/uploads/00000000001.png。
许可
此包是开源软件,许可协议为 MIT 许可协议。