tuefekci/deta

此包的最新版本(v0.0.5)没有提供许可证信息。

v0.0.5 2023-04-05 16:21 UTC

This package is auto-updated.

Last update: 2024-09-05 19:18:14 UTC


README

这是一个用于 Deta API 的 PHP 客户端。

通过 https://deta.space/discovery/@tuefekci/phpsandbox 探索客户端 Deta 空间

安装

您可以通过 composer 安装此包

composer require tuefekci/deta

用法

要使用 Deta 客户端,首先创建一个 Deta 类的实例,传入您的项目 ID 和 API 密钥

use tuefekci\deta\Deta;

$deta = new Deta('your_project_id', 'your_api_key');

如果您已设置环境变量或在 Deta 微型环境中,可以省略密钥。

use tuefekci\deta\Deta;
$deta = new Deta();

然后,您可以使用 base 方法获取项目中基础数据的引用

$my_base = $deta->base('my_base');

然后,您可以使用基础上的方法与存储在基础中的项目交互

// Insert an item
$my_base->insert(['name' => 'Alice', 'age' => 30]);

// Get an item by key
$item = $my_base->get('abc123');

// Update an item
$my_base->update('abc123', ['name' => 'Bob']);

// Delete an item
$my_base->delete('abc123');

// Query items
$items = $my_base->query(['age' => ['lt' => 40]]);

同样,您可以使用 drive 方法获取项目中驱动数据的引用

$my_drive = $deta->drive('my_drive');

然后,您可以使用驱动上的方法与存储在驱动中的文件交互

// Upload a file
$my_drive->put('file.txt', 'Hello, world!');

// Download a file
$content = $my_drive->get('file.txt');

// List files
$files = $my_drive->list();

Deta-PHP 类和文件文档

此存储库包含 Deta-PHP,这是一个用于与 Deta API 交互的 PHP SDK。该 SDK 包含以下文件和类

deta.php

此文件包含用于实例化 Deta 客户端的 Deta 类。该 Deta 类构造函数接受以下参数

  • project_id:Deta 项目 ID
  • api_key:Deta 项目 API 密钥
  • options:一个可选的 Guzzle HTTP 客户端选项数组

Deta 类提供了以下方法

  • base($base_name):创建并返回一个新的 Base 实例
  • drive($drive_name):创建并返回一个新的 Drive 实例

base.php

此文件包含用于与 Deta Base 交互的 Base 类。该 Base 类构造函数接受一个参数,即 Guzzle HTTP 客户端实例。

Base 类提供了以下方法

  • put($items):在基础中添加或更新项目
  • get($key):通过键检索基础中的项目
  • delete($key):通过键从基础中删除项目
  • insert($item):将新项目添加到基础
  • update($key, $set = null, $increment = null, $append = null, $delete = null):通过键在基础中更新项目
  • query($query = null, $limit = null, $last = null):查询基础

drive.php

此文件包含用于与 Deta Drive 交互的 Drive 类。该 Drive 类构造函数接受一个参数,即 Guzzle HTTP 客户端实例。

Drive 类提供了以下方法

  • put($name, $content, $content_type = null):将新文件上传到 Deta Drive
  • initializeChunkedUpload($name):初始化对 Deta Drive 的分块上传
  • uploadChunkedPart($upload_id, $name, $part, $content):将分块上传的一部分上传到 Deta Drive
  • endChunkedUpload($upload_id, $name):结束对 Deta Drive 的分块上传
  • abortChunkedUpload($upload_id, $name):中止对 Deta Drive 的分块上传
  • get($name):从 Deta Drive 中检索文件
  • list($limit = null, $prefix = null, $last = null):列出 Deta Drive 中的文件
  • delete($name):通过文件名从 Deta Drive 中删除文件

命名空间

所有类都定义在 tuefekci\deta 命名空间中。要在 PHP 代码中使用 SDK,请包含以下语句

use tuefekci\deta\Deta;
use tuefekci\deta\Base;
use tuefekci\deta\Drive;

许可证

MIT 许可证(MIT)。请参阅 许可证文件 获取更多信息。