README

使用 PHP 访问 Airtable 数据。

需求

PHP 5.6.0 及以上版本。

安装

您可以通过 Composer 安装此库。运行以下命令

composer require knut/airtable-php

用法

创建客户端

1. 注册 Airtable 账户并在此处找到您的 API 密钥：[https://airtable.com/account](https://airtable.com/account)
2. 创建一个新的基础并在此处找到您的 Base ID：[https://airtable.com/api](https://airtable.com/api)

您的 API 密钥具有与您的用户账户相同的权限，因此请务必保密！

现在您可以创建您的 Airtable 客户端

$airtable = new \Airtable\Client($apiKey, $baseId);

查找记录

现在您可以使用以下语法查询基础中表格的一组记录

$records = $airtable->companies->find();

其中 companies 是您的 Airtable 基础中表格的名称。注意您可以通过 Airtable 客户端上的命名属性访问所有表格。

请注意，您只能在一个查询中请求最多 100 条记录。要检索更多记录，请使用下面的“批处理”功能。

按视图名称查找记录

在 Airtable 中，您可以在命名的 视图 中创建预定义的过滤器。这对于许多查询来说可以是一个非常有用的起点，因为您不需要在代码中指定所有过滤器，只需引用一个命名的视图。

这是如何查找名为视图的记录

$records = $airtable->companies->find(['view' => 'Name of your view in Airtable']);

按过滤公式查找记录

您可以使用 公式 通过 filterByFormula 参数使用代码过滤记录。

例如，要仅包括 website_url 不为空的记录，可以使用

$records = $airtable->companies->find([
    'filterByFormula' => "NOT({website_url} = '')"
]);

仅选择您需要的

非常常见的情况是您不需要结果集中所有数据。您可以使用 fields 参数减少传输的数据量。

例如，要仅返回 name 和 website_url 的数据，请在参数中指定这两个字段名

$records = $airtable->companies->find([
    'fields' => ['name', 'website_url']
]);

排序

您可以在查询中指定排序顺序、限制和偏移。

限制

待定

分页

待定

批量查询所有记录

待定

查找记录

您可以使用表上的 find 函数通过 id 查询记录。

$company = $airtable->companies->find("rec3APJV3yRHlpHoA");

创建记录

您可以使用表上的 create 函数创建记录。

$company = $airtable->companies->create([
    'name' => 'New Company',
    'website_url' => 'https://example.com',
]);

更新记录

您可以使用表上的 update 函数更新记录。

$company->name = 'An Updated Company';
$updatedRecord = $airtable->companies->update($company);

删除记录

您可以使用表上的 delete 函数删除记录。

$result = $airtable->companies->delete($record);

开发

获取 Composer。例如，在 Mac OS 上

brew install composer

安装依赖项

composer install

使用 phpunit 运行测试套件

$ ./vendor/bin/phpunit

代码覆盖率报告位于 build/coverage-report 中。

贡献

1. 将其分支（[https://github.com/knut/airtable-php/fork](https://github.com/knut/airtable-php/fork)）
2. 创建您的功能分支（git checkout -b my-new-feature）
3. 提交您的更改（git commit -am '添加一些功能'）
4. 推送到分支（git push origin my-new-feature）
5. 创建新的 Pull Request

许可证

MIT