{"id":13501168,"url":"https://github.com/Beachcasts/airtable-sdk-php","last_synced_at":"2025-03-29T08:32:11.849Z","repository":{"id":62492522,"uuid":"250050208","full_name":"Beachcasts/airtable-sdk-php","owner":"Beachcasts","description":"Flexible SDK for the Airtable API for PHP.","archived":false,"fork":false,"pushed_at":"2020-06-05T02:42:26.000Z","size":452,"stargazers_count":5,"open_issues_count":1,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-31T20:39:18.846Z","etag":null,"topics":["airtable","airtable-api","airtable-client","php","php-library","sdk","sdk-php"],"latest_commit_sha":null,"homepage":"https://beachcasts.github.io/airtable-sdk-php/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Beachcasts.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["beachcasts"]}},"created_at":"2020-03-25T17:48:54.000Z","updated_at":"2023-10-30T15:05:53.000Z","dependencies_parsed_at":"2022-11-02T11:30:59.178Z","dependency_job_id":null,"html_url":"https://github.com/Beachcasts/airtable-sdk-php","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beachcasts%2Fairtable-sdk-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beachcasts%2Fairtable-sdk-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beachcasts%2Fairtable-sdk-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Beachcasts%2Fairtable-sdk-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Beachcasts","download_url":"https://codeload.github.com/Beachcasts/airtable-sdk-php/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246162092,"owners_count":20733351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["airtable","airtable-api","airtable-client","php","php-library","sdk","sdk-php"],"created_at":"2024-07-31T22:01:27.827Z","updated_at":"2025-03-29T08:32:11.498Z","avatar_url":"https://github.com/Beachcasts.png","language":"PHP","funding_links":["https://github.com/sponsors/beachcasts"],"categories":["PHP"],"sub_categories":[],"readme":"# airtable-sdk-php\n\n[![Latest Version on Packagist][ico-version]][link-packagist]\n[![Software License][ico-license]](LICENSE.md)\n[![Build Status][ico-travis]][link-travis]\n[![Coverage Status][ico-scrutinizer]][link-scrutinizer]\n[![Quality Score][ico-code-quality]][link-code-quality]\n[![Total Downloads][ico-downloads]][link-downloads]\n\nThis Airtable SDK for PHP makes it easier to leverage the Airtable API leveraging popular PHP conventions.\n\nNOTE: This project is under active development, and is NOT ready for use.\n\n## Documentation\n\nGo to: [https://beachcasts.github.io/airtable-sdk-php/](https://beachcasts.github.io/airtable-sdk-php/)\n\n## Prerequisites\n\n* Composer installed globally\n* PHP v7.2+\n\n## Install\n\nVia Composer\n\n``` bash\n$ composer require beachcasts/airtable-sdk-php\n```\n\n## Quick Start\n\nBase usage requires instantiation of the AirtableClient, as shown below:\n\n``` php\nrequire_once('vendor/autoload.php');\n\nuse Beachcasts\\Airtable\\AirtableClient;\nuse Beachcasts\\Airtable\\Config;\n\n// Add details to your environment - see documentation for recomendations\n\n$airtableClient = new AirtableClient(Config::fromEnvironment(), \u003cyour_baseid\u003e);\n$table = $airtableClient-\u003egetTable(\u003cyour_table_name\u003e);\n```\n\n##### NOTES:\n1. Update `\u003cyour_baseid\u003e` and `\u003cyour_table_name\u003e` as needed.\n1. the `Config::fromEnvironment`\n\nFor more details of how to use the AirtableClient, see the [/docs](https://beachcasts.github.io/airtable-sdk-php/), where examples highlight using `create()`, `read()`, `update()`, `delete()`, and `list()` methods on/with Airtable data.\n\n## Change log\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Testing\n\nAirtable-SDK has 3 Test Suites: Full, Unit and Integration, we include a Dev requirement against PHPUnit.\nPlease make sure you run the composer install to get all dependencies.\n```bash\n$ composer install\n```\n\n#### Unit Tests\n\nRunning the unit tests is simply telling phpunit to run the \"unit\" testsuite\n\n```bash\n$ vendor/bin/phpunit --testsuite=unit\n```\n\n#### Integration Tests\n\nRunning the integration tests will require an actual account and details from Airtable.\n\n1. Copy the file `tests\\.env.default` to `tests\\.env`\n1. Log into your Airtable account\n1. `Add a base` using the `Start from scratch` method.\nLet the new base creation retain the default `Untitled Base` name.\n1. Visit [Airtable API docs](https://airtable.com/api) and select your `Base`\n1. Copy the Base ID from the Introduction section. Look for `The ID of this base is`\nAdd this to the `tests\\.env` under the `TEST_BASE_ID` key\n1. Go to [Your account](https://airtable.com/account) and copy your API Key.\nAdd this to the `tests\\.env` under the `AIRTABLE_API_KEY` key\n1. If you have changed the default Table name away from `Table 1` - update the `TEST_TABLE_NAME` in the `tests\\.env`\n\nOnce the .env is configured, tests can be run with the following command:\n```bash\n$ vendor/bin/phpunit --testsuite=integration\n```\n\n#### Full Test Suite\n\nTo run the full Test Suite, you will need to follow the steps outlined for Integration testing. To Exceute, run the following command:\n```bash\n$ vendor/bin/phpunit --testsuite=full\n```\nor\n```bash\n$ vendor/bin/phpunit\n```\n\n## Quality Control\n\nTo maintain quality control, we maintain use of the following standards:\n* [PSR-2](https://www.php-fig.org/psr/psr-2/) Coding Standard,\n* [PSR-4](https://www.php-fig.org/psr/psr-4/) standard for Autoload locations (via composer)\n* [PSR-7](https://www.php-fig.org/psr/psr-7/) standard for HTTP messages (via GuzzleHttp implementation)\n\nWe provide a `phpcs.xml.dist` within the codebase to validate the Coding standard using Code Sniffer (included as dev dependency in our composer.json manifest)\n\nTo run the codesniffer against the codebase, use the following command.\n\n```bash\n$ vendor/bin/phpcs --standard=phpcs.xml.dist src\n```\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.\n\n## Security\n\nIf you discover any security related issues, please email beachcasts@gmail.com instead of using the issue tracker.\n\n## Credits\n\n- [Beachcasts][link-author]\n- [All Contributors][link-contributors]\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n[ico-version]: https://img.shields.io/packagist/v/beachcasts/airtable-sdk-php.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-travis]: https://img.shields.io/travis/beachcasts/airtable-sdk-php/master.svg?style=flat-square\n[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/beachcasts/airtable-sdk-php.svg?style=flat-square\n[ico-code-quality]: https://img.shields.io/scrutinizer/g/beachcasts/airtable-sdk-php.svg?style=flat-square\n[ico-downloads]: https://img.shields.io/packagist/dt/beachcasts/airtable-sdk-php.svg?style=flat-square\n\n[link-packagist]: https://packagist.org/packages/beachcasts/airtable-sdk-php\n[link-travis]: https://travis-ci.com/beachcasts/airtable-sdk-php\n[link-scrutinizer]: https://scrutinizer-ci.com/g/beachcasts/airtable-sdk-php/code-structure\n[link-code-quality]: https://scrutinizer-ci.com/g/beachcasts/airtable-sdk-php\n[link-downloads]: https://packagist.org/packages/beachcasts/airtable-sdk-php\n[link-author]: https://github.com/beachcasts\n[link-contributors]: ../../contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBeachcasts%2Fairtable-sdk-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBeachcasts%2Fairtable-sdk-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBeachcasts%2Fairtable-sdk-php/lists"}