Airtable collection model

[johanjanssens]

Collection model for Airtable. Install by adding the following code to /joomlatools-pages/extensions/pages/model/airtable.php

<?php
class ExtPagesModelAirtable extends ComPagesModelWebservice
{
    protected function _initialize(KObjectConfig $config)
    {
        $config->append([
            'api_key'    => null,
            'data_path'   => 'records',
            'cache_path'  =>  $this->getObject('com://site/pages.config')->getCachePath().'/airtable',
        ]);
       
        parent::_initialize($config);
    }
    
    public function getHeaders($cache = true)
    {
        $headers = parent::getHeaders($cache);
        $headers['Authorization'] = 'Bearer '.$this->getConfig()->api_key;

        return $headers;
    }
    
    public function fetchData($count = false)
    {
        $data = parent::fetchData();
        array_walk($data, function(&$item)
        {
            $item += $item['fields'];
            unset($item['fields']);
        });
        
        //Check if the database has a lastModified column
        if(!$this->_hash_key && array_key_exists('lastModified', $data[0])) {
            $this->_hash_key = array('lastModified');
        }
        
        return $data;
    }
}

In your page frontmatter define the collection as follows.

---
collection:
    model: airtable
    config:
        url: https://api.airtable.com/[...]/[...]
        api_key: [...]
        identity_key: [name_of_autonumber_field]
---

Use as:

<?  foreach(collection() as $item): ?>
<? var_dump($item) ?>
<? endforeach; ?>

• The identity_key is not required but it's recommended to have a unique field in your table to make it easy to query a single record. You can use the Autonumber field for this: https://support.airtable.com/hc/en-us/articles/360042807273-Autonumber-field

• For more complex tables it's recommended to add a Last Modified Time field: https://support.airtable.com/hc/en-us/articles/360022745493-Last-modified-time-field to your table. This gives you more granular control over the how the collection hash is calculated.

Thats it! Happy coding

[kbrookes]

Fantastic, I have a use for this coming up I think...

[kbrookes]

Note - @johanjanssens fixed a typo in the above extension. It should be:

<?php
class ExtPagesModelAirtable extends ComPagesModelWebservice
{
    protected function _initialize(KObjectConfig $config)
    {
        $config->append([
            'api_key'    => null,
            'data_path'   => 'records',
            'cache_path'  =>  $this->getObject('com://site/pages.config')->getCachePath().'/airtable',
        ]);
       
        parent::_initialize($config);
    }
    
    public function getHeaders($cache = true)
    {
        $headers = parent::getHeaders($cache);
        $headers['Authorization'] = 'Bearer '.$this->getConfig()->api_key;

        return $headers;
    }
        $headers['Authorization'] = 'Bearer '.$this->getConfig()->api_key;

        return $headers;
    }
    
    public function fetchData($count = false)
    {
        $data = parent::fetchData();
        array_walk($data, function(&$item)
        {
            $item += $item['fields'];
            unset($item['fields']);
        });
        
        //Check if the database has a lastModified column
        if(!$this->_hash_key && array_key_exists('lastModified', $data[0])) {
            $this->_hash_key = array('lastModified');
        }
        
        return $data;
    }
}

[johanjanssens]

Updated the initial snippet too :)

[woluweb]

apparently line 15
public function getHeaders()
should be replaced by
public function getHeaders($cache = true)
in order to avoid the following error:
Warning: Declaration of ExtPagesModelAirtable::getHeaders() should be compatible with ComPagesModelWebservice::getHeaders($cache = true) in /_pages/joomlatools-pages/extensions/pages/model/airtable.php on line 15

[johanjanssens]

@woluweb Good find. Thats indeed correct. See https://github.com/joomlatools/joomlatools-pages/blob/master/code/model/webservice.php#L66

Updated the snippet.