lee-to/php-airtable

AirTable API client for PHP

v1.0.1 2020-07-09 12:22 UTC

Requires

• php: ^7.1
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• guzzlehttp/guzzle: ~6.0
• mockery/mockery: ^1.0
• phpunit/phpunit: ^4.8.35 || ^5.7

Suggests

• guzzlehttp/guzzle: Allows for implementation of the Guzzle HTTP client

MIT

• Danil Shutsky

• api
• airtable

README

AirTable API client for PHP

Installation

The AirTable Client PHP can be installed with Composer. Run this command:

composer require lee-to/php-airtable

Usage

Get token and base from AirTable Account and AirTable API

Import.

use Airtable;

Init.

• optional param $http_client = "curl" or "guzzle". Default guzzle if exist or curl

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

Get records from that table

• List table records

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

Get one record from table.

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

Filter records

• First argument is the column name
• Second argument is the operator or the value if you want to use equal '=' as an operator.
• Third argument is the value of the filter

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

Sort records

• First argument is the column name
• Second argument is direction.

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

Fields

• Only data for fields whose names are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred

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

Max records

• The maximum total number of records that will be returned in your requests. If this value is larger than pageSize (which is 100 by default), you may have to load multiple pages to reach this total.

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

Page size

• The number of records returned in each request. Must be less than or equal to 100. Default is 100.

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

Offset

• Set offset ID for next page

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

Update

• Update one record

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

OR

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

Create

• Create a new record

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

Delete

• Delete one record

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

OR

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

Get fields of record

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

Tests

1. Composer is a prerequisite for running the tests. Install composer globally, then run composer install to install required files.
2. Get personal API key and Base AirTable, then create tests/AirTableTestCredentials.php from tests/AirTableTestCredentials.php.dist and edit it to add your credentials.
3. The tests can be executed by running this command from the root directory:

$ ./vendor/bin/phpunit

See also

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

Contributing

Please see CONTRIBUTING for details.

Credits

• Danil Shutsky
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Security

If you have found a security issue, please contact the maintainers directly at [e-mail].