Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielstieber/codaphp
PHP library to use data from Coda documents in webprojects (via Coda API)
https://github.com/danielstieber/codaphp
coda composer php
Last synced: 18 days ago
JSON representation
PHP library to use data from Coda documents in webprojects (via Coda API)
- Host: GitHub
- URL: https://github.com/danielstieber/codaphp
- Owner: danielstieber
- License: mit
- Created: 2018-11-11T18:58:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-27T11:35:52.000Z (about 2 years ago)
- Last Synced: 2024-10-09T05:51:38.392Z (28 days ago)
- Topics: coda, composer, php
- Language: PHP
- Size: 41 KB
- Stars: 28
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CodaPHP
=======================
[](https://github.com/danielstieber/codaphp/releases)
[](https://coda.io/developers/apis/v1)
* [Quickstart](#Quickstart)
* [Detailed Documentation](#Documentation)
* [Doc & Pack Analytics](#Analytics)
* [Caching](#Caching)
* [Changelog](#Changelog)
CodaPHP is a library that makes it easy to use data from [Coda](https://www.coda.io) docs in web projects by using the [Coda API](https://coda.io/developers/apis/v1).
Easily use all available API calls with one library including
* List all documents
* Read data from tables, formulas and controls
* Add/modify rows
* Manage doc permissions
* and a lot more
→ [**Get 10$ discount on Coda paid plans when signing up with this link**](https://coda.io/?r=Qjx7OzpmTa2L6IPfkY-anw)
## Quickstart
### Installation and basic usage
Install the library through [Composer](http://getcomposer.org/):
```bash
php composer.phar require danielstieber/coda-php
```
and add it to your project:
```PHP
require './vendor/autoload.php';
$coda = new CodaPHP\CodaPHP('');
// List all your docs
$result = $coda->listDocs();
var_dump($result);
```
### Handling table data
Let's assume you have the table 'Products' in your Coda doc:
#### Products
| Title ⚑ | Price | Status |
|-----------|-------|-------------|
| Goatmilk | 14.90 | available ▼ |
| Goatmeat | 38.90 | available ▼ |
```PHP
// Get the price of the goatmilk
$docId = $coda->getDocId('');
// Lists only Products with status 'available' (currently only one filter allowed)
$availableProducts = $coda->listRows($docId, 'Products', ['query' => ['status' => 'available']]);
// Show value of one cell
$result = $coda->getRow($docId, 'Products', 'Goatmilk');
var_dump($result['values']['Price']);
// Will show you 'float(14.90)'
// Add the new product 'Goatcheese'
if($coda->insertRows($docId, 'Products', ['Title' => 'Goatcheese', 'Price' => 23.50, 'Status' => 'available'])) {
echo 'Product added';
}
// Change the status of the product 'Goatmilk' to 'sold out'
if($coda->insertRows($docId, 'Products', ['Title' => 'Goatmilk', 'Status' => 'sold out'], ['Title'])) {
echo 'Product updated';
}
```
### Triggering automations
Since May 2022, Coda automations can be triggered via webhooks – and via CodaPHP. To trigger an automation, the automation must be set to "Webhook invoked". To run the automation you need the doc ID an the ID of the automation rule. You can find the rule ID when you click on the 3 dots (kebap menu) above the rule step settings.
```PHP
// Trigger the automation
$result = $coda->runAutomation('', '');
```
## Overview
This is a personal side project. If you have any suggestions, find bugs or want to contribute, don't hesitate to contact me. You can use the [offical Coda community](https://community.coda.io/) to asks questions and reach out as well.
### Token
Generate your token in the Coda profile settings. *Notice: Everyone with this token has full access to all your docs!*
### Methods
The method names are inspired by the wording of the [official Coda API documentation](https://coda.io/developers/apis/v1beta1) and are listed below.
### Parameters
All parameters can be found in the [official Coda API documentation](https://coda.io/developers/apis/v1beta1). Just add an associative array with your parameters to selected functions. The parameter _useColumnNames_ is set true by default in all 'row' functions. I list the important ones below.
### Response
In case of success, responses are mostly untouched but converted to PHP arrays. Exception is `insertRow()` function, which provides a boolean true in case of success.
In case of an error, the response includes the statusCode and provided error message, also untouched and converted to an array.
### Cache data
Every API call may take a few seconds. It is recommended to store results and only call for new when necessary. The library provides a simple caching mechanic to store received data in a .codaphp_cache folder. **This mechanic is optional** and needs to be activated. Learn more in the [caching instructions](#Caching)
## Documentation
```PHP
$coda = new CodaPHP(''); // Create instance of CodaPHP
```
### Docs
```PHP
$coda->getDocId(''); // Get the id of a doc
$coda->listDocs(); // List all docs you have access to
$coda->listDocs(['query' => 'todo']); // List docs filtered by searchquery 'todo'
$coda->getDoc(''); // Get a specific doc
$coda->createDoc('My new doc'); // Create a new doc
$coda->createDoc('Copy of my old doc', ''); // Copy a doc
```
### Pages (former Folders & Sections)
```PHP
$coda->listPages(''); // List all sections in a doc
$coda->getPage('', ''); // Get a section in a doc
```
### Tables/Views, Columns and Rows
```PHP
$coda->listTables(''); // List all tables in a doc
$coda->getTable('', ''); // Get a table in a doc
$coda->listColumns('', ''); // List all columns in a table
$coda->getColumn('', '', ''); // Get a column in a table
$coda->listRows('', ''); // List all row in a table
$coda->insertRows('', '', [['' => '']], ['']); // Insert/updates a row in a table
// Examples:
$coda->insertRows('', 'todos', ['title' => 'Shower']); // Adds one row to 'todo'
$coda->insertRows('', 'todos', [['title' => 'Wash dishes'], ['title' => 'Clean car']]); // Adds two rows to 'todo'
$coda->insertRows('', 'todos', [['title' => 'Shower', 'status' => 'done'], ['title' => 'Buy goatcheese']], ['title']); // Updates the status of 'Shower' and inserts a new todo
$coda->updateRow('', '', '', ['' => '']); // Updates a row in a table
$coda->getRow('', '', ''); // Get a row in a table
$coda->deleteRow('', '', ''); // Deletes a row in a table
```
### Working with Views
Since Coda API Version 1.0.0 there are no seperate view methods. All view operations can be done via the table methods.
### Pushing Buttons
```PHP
$coda->pushButton('', '', '', '); // Pushes the button on the given column in a table
```
### Formulas and Controls
```PHP
$coda->listFormulas(''); // List all formulas in a doc
$coda->getFormula('', ''); // Get a formula in a doc
$coda->listControls(''); // List all controls in a doc
$coda->getControl('', ''); //Get a control in a doc
```
### Manage permissions
```PHP
$coda->listPermissions(''); // Get information about users & permissions for a doc
$coda->addUser('', ''); // Add a user to a doc (default permissions are 'write')
$coda->addUser('', '', 'readonly', true); // Add a 'readonly' user and notify via email
$coda->deleteUser('', ''); // Removes a user from the doc
$coda->addPermission('', '', '', ''); // Add a permission to a doc
$coda->deletePermission('', ''); // Remove a permission from a doc
$coda->getACLMetadata(''); // Returns the ACL metadata of a doc
```
Learn more about permission settings with the API [here](https://coda.io/developers/apis/v1#tag/ACLs).
### Run automations / trigger webhooks
```PHP
$coda->runAutomation('', '');
```
### Account and other
```PHP
$coda->whoAmI(); // Get information about the current account
$coda->resolveLink(''); // Resolves a link
$coda->getMutationStatus(''); // Resolves a link
```
### Analytics
```PHP
$coda->listDocAnalytics(); // List all docs with analytics data
$coda->listDocAnalytics(['query' => 'Goats', 'sinceDate' => '2022-08-02', 'sinceDate' => '2022-08-04']); // List docs about "Goats" with analytics data between 2nd and 4th of August 2022
// All parameters for all methods can be found in the official API docs: https://coda.io/developers/apis/v1#tag/Analytics/operation/listDocAnalytics
$coda->listPageAnalytics(''); // List analytics data on page level of given doc
$coda->listPackAnalytics(); // List all packs where user has edit rights with analytics data
$coda->listPackAnalytics(['workspaceId' => 'ws-123Ave']); // List all packs where user has edit rights with analytics data from workspace ws-123Ave
$coda->listPackFormulaAnalytics('getDocAnalyticsSummery(); // Returns summarized analytics data for available docs.
$coda->getPackAnalyticsSummery(); // Returns summarized analytics data for available packs.
$coda->getAnalyticsUpdatedDay(); // Returns days based on Pacific Standard Time when analytics were last updated. Usually 1 day ago PST.
```
## Caching
The library can cache API requests in JSON files. If caching is activated, the library tries to create a `.codaphp_cache` folder in your project root. If it can't create or find the folder, it will deactivate caching. You can also create the folder on your own and set CHMOD so the library can read & write files in it. Only doc data & content will be cached, no permissions, links or mutation status!
```PHP
$coda = new CodaPHP('', '', ''); // Instance creation with otptional caching & expiry time
$coda = new CodaPHP('', true); // Instance with activated caching
```
By default, the cache will expire after 7 days. You can manually change the expiry time.
```PHP
$coda = new CodaPHP('', true, 86400); // Activate caching and set cache to 1 day (in seconds)
```
You can also clear the cache manually
```PHP
$coda->clearCache(); // Clears the whole cache
```
#### Control cache inside the doc
A simple way to control the cache status from the coda doc is a button that triggers the clear cache method.
```PHP
$coda = new CodaPHP('', true);
if(isset($_GET['clearCache'])) {
$coda->clearCache();
}
```
Now you can add a "open hyperlink"-button in your doc that opens https://yourdomain.com/?clearCache. After clicking the button the website will receive the latest data and saves it in the cache again.
## Changelog
### 0.4.0 (August 28, 2022)
* Update to API version 1.3.0
* New features:
- Added Analytics endpoints
* Bug fixes:
- Improved getDocId() regex for better matching
### 0.3.0 (May 24, 2022)
* Update to API version 1.2.6.
* New features:
- Trigger "Webhook invoked" automations
### 0.2.0 (January 3, 2021)
* Update to API version 1.1.0.
* New features:
- Added ACL permission management
- Added optional caching
### 0.1.0 (August 15, 2020)
* Update to API version 1.0.0.
* Breaking changes:
- Sections & Folders have been replaced by pages
- Removed 'view' methods. You can access views via table methods.
* New features:
- Added mutation status method
You can read more about API version 1.0.0 [here](https://community.coda.io/t/launched-coda-api-v1/17248)
### 0.0.4 (February 16, 2020)
* Updated to API version 0.2.4-beta. New features:
- Pushing buttons inside of tables & views
- Getting and interacting with views
- Creating docs in folders
- Ability to disable parsing of cell values
### 0.0.3 (March 16, 2019)
* Fixed an issue with using queries in listRows (Thanks to [Al Chen](https://github.com/albertc44) from Coda for mentioning this)
### 0.0.2 (November 15, 2018)
* Fixed an issue regarding table names with special characters (Thanks to Oleg from Coda for mentioning this)
### 0.0.1 (November 11, 2018)
* Initial version based on v0.1.1-beta of Coda API