README

PHP 的 AirTable API 客户端

安装

可以使用 Composer 安装 AirTable Client PHP。运行此命令

composer require lee-to/php-airtable

用法

从 AirTable 账户 和 AirTable API 获取令牌和基础

导入。

use Airtable;

初始化。

• 可选参数 $http_client = "curl" 或 "guzzle"。如果存在则默认为 guzzle 或 curl

$client = new AirTable($token, $base, $http_client);

从该表获取记录

• 列出表记录

$client->table('table_name')->list();

从表中获取一条记录。

$client->table('table_name')->retrieve('ID');

筛选记录

• 第一个参数是列名
• 第二个参数是运算符或值（如果您想使用 '=' 作为运算符）。
• 第三个参数是筛选值

$client->table('table_name')->filterByFormula("column", "operator", "value")->list();

排序记录

• 第一个参数是列名
• 第二个参数是方向。

$client->table('table_name')->sort("column", "direction")->list();

字段

• 仅包含此列表中字段名的数据将被包含在结果中。如果您不需要每个字段，可以使用此参数来减少传输的数据量

$client->table('table_name')->fields(["Column1", "Column2"])->list();

最大记录数

• 请求中将返回的最大记录总数。如果此值大于 pageSize（默认为 100），您可能需要加载多个页面才能达到此总数。

$client->table('table_name')->maxRecords(15)->list();

页面大小

• 每个请求返回的记录数。必须小于或等于 100。默认为 100。

$client->table('table_name')->pageSize(15)->list();

偏移

• 设置下一页的偏移 ID

$client->table('table_name')->offset('ID')->list();

更新

• 更新一条记录

$client->table('table_name')->update('ID', ["Column1" => "Value"]);

或

foreach($client->table('table_name')->list() as $record) {
    $record->update(["Column1" => "Value"]);
}

创建

• 创建新记录

$client->table('table_name')->create(["Column1" => "Value"]);

删除

• 删除一条记录

$client->table('table_name')->delete('ID');

或

foreach($client->table('table_name')->list() as $record) {
    $deleted = $record->delete();
    
    $deleted->isDeleted(); // Check is deleted or not
}

获取记录字段

foreach($client->table('table_name')->list() as $record) {
    $record->getId(); // ID 
    
    $record->COLUMN1; // Any fields in table 
}

测试

1. Composer 是运行测试的先决条件。全局安装 composer，然后运行 composer install 以安装所需文件。
2. 获取个人 API 密钥和基础 AirTable，然后从 tests/AirTableTestCredentials.php.dist 创建 tests/AirTableTestCredentials.php 并编辑它以添加您的凭据。
3. 可以从根目录运行此命令来执行测试

$ ./vendor/bin/phpunit

另请参阅

• [Laravel Airtable] (https://github.com/lee-to/laravel-airtable)

贡献

有关详细信息，请参阅 CONTRIBUTING

致谢

• 丹尼尔·舒茨基
• 所有贡献者

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅 许可文件

安全

如果您发现安全漏洞，请直接联系维护者 leetodev@ya.ru。