davidzadrazil / airtable-api-php
PHP 包装器用于 Airtable API
0.0.3
2017-11-23 10:45 UTC
Requires
- php: >=7.0.1
- lib-curl: *
- guzzlehttp/guzzle: ^6.3
This package is not auto-updated.
Last update: 2024-09-19 14:06:19 UTC
README
PHP 包装器用于 Airtable API。
入门指南
Airtable API 不允许操作基础或表中的字段。因此,您必须手动在 Airtable 界面中创建表格及其字段。
重要
每个基础都有自己的文档,其中包含 base
标识符(以 app
开头,例如 appGYr9gxkAk0wKNk
),这是必需的参数。API 密钥
位于 账户设置。
安装
安装 davidzadrazil/airtable-api-php 的最佳方式是使用 Composer
$ composer require davidzadrazil/airtable-api-php
用法
初始化
首先,您必须初始化 Airtable 类和请求处理器
$airtable = new DavidZadrazil\AirtableApi\Airtable('API_KEY', 'BASE_ID'); $request = new DavidZadrazil\AirtableApi\Request($airtable, 'TABLE_NAME');
获取记录
重要:Airtable 限制响应的最大记录数为 100 条。
$tableRequest = $request->getTable(); do { foreach ($tableRequest->getRecords() as $record) { echo $record->getName(); echo $record->getEmail(); echo $record->getAnotherValue(); } } while ($tableRequest = $tableRequest->nextPage());
getRecords()
返回一个包含 AirtableApi\Record 的数组。
过滤与其他参数
可以从表格中获取记录,可以使用如 filterByFormula
、maxRecords
、pageSize
、sort
或 view
等可用参数。
$request->getTable(['pageSize' => 50, 'filterByFormula' => '{Name} = "test"']);
创建记录
$response = $request->createRecord( [ 'Name' => 'This appears in Name field', 'Email' => 'john@doe.com', 'LinkToAnotherTable' => ['recsH5WYbYpwWMlvb'] ] ); $response->isSuccess(); // true / false $response->getRecords(); // returns newly created record with ID
更新记录
使用给定的记录 ID 更新特定记录。
$response = $request->updateRecord('recsH5WYbYpwWMlvb', ['Name' => 'Updated value']); $response->isSuccess(); // true / false
删除记录
删除具有给定记录 ID 的特定记录。
$response = $request->deleteRecord('recsH5WYbYpwWMlvb'); $response->isSuccess(); // true / false