airtable sdk php

Airtable-SDK-Php

Dieser Airtable SDK für PHP erleichtert es, die Airtable -API zu nutzen, die beliebte PHP -Konventionen nutzt.

HINWEIS: Dieses Projekt befindet sich unter aktiver Entwicklung und ist nicht bereit für den Einsatz.

Dokumentation

Gehen Sie zu: https://beachcasts.github.io/airtable-sdk-php/

Voraussetzungen

• Komponist global installiert
• PHP V7.2+

Installieren

Über Komponist

$ composer require beachcasts/airtable-sdk-php

Schneller Start

Die Basisnutzung erfordert die Instanziierung des AirTableClient, wie unten gezeigt:

 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>);

Anmerkungen:

1. Aktualisieren Sie <your_baseid> und <your_table_name> nach Bedarf.
2. Die Config::fromEnvironment

Weitere Informationen zur Verwendung des AirTableClient finden Sie in den Methoden für create() , read() , update() , delete() und list() auf /mit Airtable -Daten.

Protokoll ändern

Weitere Informationen zu dem, was sich in letzter Zeit geändert hat, finden Sie in ChangeLog.

Testen

Airtable-SDK verfügt über 3 Testsuiten: Voll, Einheit und Integration, wir enthalten eine Entwicklungsanforderung gegen Phpunit. Bitte stellen Sie sicher, dass Sie die Komponist -Installation ausführen, um alle Abhängigkeiten zu erhalten.

$ composer install

Unit -Tests

Das Ausführen der Unit -Tests fordert Phpunit einfach auf, die "Einheit" -Testsuite auszuführen

$ vendor/bin/phpunit --testsuite=unit

Integrationstests

Das Ausführen der Integrationstests erfordert ein tatsächliches Konto und Details von Airtable.

1. Kopieren Sie die Dateitests tests.env.default , um tests.env
2. Melden Sie sich in Ihrem Airtable -Konto an
3. Add a base mit der Start from scratch -Kratzermethode hinzu. Lassen Sie die neue Basiserstellung den Standardnamen Untitled Base behalten.
4. Besuchen Sie Airtable -API -Dokumente und wählen Sie Ihre Base aus
5. Kopieren Sie die Basis -ID aus dem Einführungsabschnitt. tests.env TEST_BASE_ID nach The ID of this base is
6. Gehen Sie zu Ihrem Konto und kopieren Sie Ihren API -Schlüssel. Fügen Sie dies zu den tests.env unter dem Schlüssel AIRTABLE_API_KEY hinzu
7. Wenn Sie den Standard -Tabellennamen aus Table 1 geändert haben - aktualisieren Sie den TEST_TABLE_NAME in den tests.env

Sobald der .Env konfiguriert ist, können Tests mit dem folgenden Befehl ausgeführt werden:

$ vendor/bin/phpunit --testsuite=integration

Vollständige Testsuite

Um die vollständige Testsuite auszuführen, müssen Sie die für Integrationstests beschriebenen Schritte ausführen. Führen Sie den folgenden Befehl aus: Führen Sie den folgenden Befehl aus:

$ vendor/bin/phpunit --testsuite=full

oder

$ vendor/bin/phpunit

Qualitätskontrolle

Um die Qualitätskontrolle aufrechtzuerhalten, behalten wir die folgenden Standards bei:

• PSR-2-Codierungsstandard,
• PSR-4-Standard für Autoload-Standorte (über Komponist)
• PSR-7-Standard für HTTP-Nachrichten (über die Implementierung von GuzzleHttp)

Wir stellen einen phpcs.xml.dist innerhalb der Codebasis zur Verfügung, um den Codierungsstandard unter Verwendung von Code -Sniffer zu validieren (als Dev -Abhängigkeit in unserem Komponisten enthalten.json -Manifest).

Verwenden Sie den folgenden Befehl zum Ausführen des CodesNiffiffers gegen die Codebasis.

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

Beitragen

Weitere Einzelheiten finden Sie unter Bereitstellung und Code_of_Conduct.

Sicherheit

Wenn Sie Sicherheitsbezogene Probleme entdecken, senden Sie bitte eine E -Mail an [email protected], anstatt den Ausgabe -Tracker zu verwenden.

Credits

• Beachcasts
• Alle Mitwirkenden

Lizenz

Die MIT -Lizenz (MIT). Weitere Informationen finden Sie unter Lizenzdatei.