README

这个 PHP 版 Airtable SDK 使得利用 Airtable API 更加容易，同时遵循流行的 PHP 习惯。

注意：该项目正在积极开发中，目前尚未准备好使用。

文档

前往：https://beachcasts.github.io/airtable-sdk-php/

先决条件

全局安装了 Composer
PHP v7.2+

安装

通过 Composer

$ composer require beachcasts/airtable-sdk-php

快速入门

基本使用需要实例化 AirtableClient，如下所示

require_once('vendor/autoload.php');

use Beachcasts\Airtable\AirtableClient;
use Beachcasts\Airtable\Config;

// Add details to your environment - see documentation for recomendations

$airtableClient = new AirtableClient(Config::fromEnvironment(), <your_baseid>);
$table = $airtableClient->getTable(<your_table_name>);

备注

根据需要更新 <your_baseid> 和 <your_table_name>。
Config::fromEnvironment

有关如何使用 AirtableClient 的更多详细信息，请参阅 /docs，其中示例强调了使用 create()、read()、update()、delete() 和 list() 方法在/与 Airtable 数据交互。

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

测试

Airtable-SDK 有 3 个测试套件：完全、单元和集成，我们包括针对 PHPUnit 的开发要求。请确保运行 composer install 以获取所有依赖项。

$ composer install

单元测试

运行单元测试就是告诉 phpunit 运行 "unit" 测试套件

$ vendor/bin/phpunit --testsuite=unit

集成测试

运行集成测试将需要实际的账户和 Airtable 的详细信息。

将文件 tests\.env.default 复制到 tests\.env
登录您的 Airtable 账户
使用 从零开始 方法 添加一个基础。让新的基础创建保留默认的 无标题基础 名称。
访问 Airtable API 文档并选择您的 基础
从简介部分复制 Base ID。查找 此基础的 ID 是 将此添加到 tests\.env 中的 TEST_BASE_ID 键下
转到您的账户并复制您的 API 密钥。将其添加到 tests\.env 中的 AIRTABLE_API_KEY 键下
如果您已将默认表名从 Table 1 更改为其他名称，请更新 tests\.env 中的 TEST_TABLE_NAME

一旦 .env 配置完毕，可以使用以下命令运行测试

$ vendor/bin/phpunit --testsuite=integration

完全测试套件

要运行完全测试套件，您需要遵循集成测试中概述的步骤。要执行，请运行以下命令

$ vendor/bin/phpunit --testsuite=full

或

$ vendor/bin/phpunit

质量控制

为了保持质量控制，我们维护以下标准

PSR-2 编码标准
PSR-4 自动加载位置标准（通过 composer）
PSR-7 HTTP 消息标准（通过 GuzzleHttp 实现）

我们在代码库中提供了一个phpcs.xml.dist文件，用于使用Code Sniffer（在composer.json清单中作为开发依赖项包含）验证编码标准。

要运行codesniffer对代码库进行检查，请使用以下命令。

$ vendor/bin/phpcs --standard=phpcs.xml.dist src

贡献

有关详细信息，请参阅CONTRIBUTING和CODE_OF_CONDUCT。

安全性

如果您发现任何与安全相关的问题，请通过电子邮件beachcasts@gmail.com反馈，而不是使用问题跟踪器。

鸣谢

许可协议

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

beachcasts / airtable-sdk-php

维护者

详细信息