bristol-su / airtable

src/AirTable.php

<?php

Missing file doc comment

namespace BristolSU\AirTable;

use GuzzleHttp\Psr7\Response;
use Psr\Http\Message\ResponseInterface;

class AirTable

Missing doc comment for class AirTable

{

    /**
     * The ID of the Progress base to use
     * 
     * @var string 
     */
    private string $baseId;

Private member variable "baseId" must be prefixed with an underscore

    /**
     * The name of the table to use
     *
     * @var string
     */
    private string $tableName;

Private member variable "tableName" must be prefixed with an underscore

    /**
     * API key to use for authentication
     * 
     * @var string 
     */
    private string $apiKey;

Private member variable "apiKey" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var \GuzzleHttp\Client 
     */
    private \GuzzleHttp\Client $client;

Private member variable "client" must be prefixed with an underscore

    public static $rateLimitCooldown = 30;
    
    public function __construct(\GuzzleHttp\Client $client)

Missing doc comment for function __construct()

    {
        $this->client = $client;
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getBaseId(): string
    {
        return $this->baseId;
    }

    /**

Missing short description in doc comment

     * @param string $baseId

Missing parameter comment

     */

Missing @return tag in function comment

    public function setBaseId(string $baseId): void
    {
        $this->baseId = $baseId;
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getTableName(): string
    {
        return $this->tableName;
    }

    /**

Missing short description in doc comment

     * @param string $tableName

Missing parameter comment

     */

Missing @return tag in function comment

    public function setTableName(string $tableName): void
    {
        $this->tableName = $tableName;
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getApiKey(): string
    {
        return $this->apiKey;
    }

    /**

Missing short description in doc comment

     * @param string $apiKey

Missing parameter comment

     */

Missing @return tag in function comment

    public function setApiKey(string $apiKey): void
    {
        $this->apiKey = $apiKey;
    }

    /**

Missing short description in doc comment

     * @param string $method

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param array|null $data

Missing parameter comment

     * 
     * @return ResponseInterface
     * 
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    protected function request(string $method = 'get', array $data = null): ResponseInterface
    {
        $options = [
            'headers' => [
                'Authorization' => 'Bearer ' . $this->apiKey
            ]
        ];
        if($data !== null) {

Expected "if (...) {\n"; found "if(...) {\n"

            if($method === 'get' || $method === 'delete') {

Expected "if (...) {\n"; found "if(...) {\n"

                $options['query'] = $data;
            } else {
                $options['json'] = $data;
            }
        }
        return $this->client->request($method,

The opening parenthesis of a multi-line function call should be the last content on the line.

            sprintf('https://api.airtable.com/v0/%s/%s', $this->baseId, $this->tableName),
            $options
        );
    }
    
    protected function execute($dataChunk, \Closure $execution)

Missing doc comment for function execute()

    {
        try {
            return $execution->call($this, $dataChunk);
        } catch (\GuzzleHttp\Exception\ClientException $exception) {
            if($exception->getCode() === 429) {

Expected "if (...) {\n"; found "if(...) {\n"

                sleep(static::$rateLimitCooldown);
                return $this->execute($dataChunk, $execution);
            } else {
                throw $exception;
            }
        }
    }

    protected function chunkAndThrottle(array $data, \Closure $execution, int $delay = 1, int $chunkSize = 10)

Missing doc comment for function chunkAndThrottle()

    {
        $chunkedData = array_chunk($data, $chunkSize, false);
        foreach($chunkedData as $key => $dataChunk) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $this->execute($dataChunk, $execution);
            if($key !== array_key_last($chunkedData)) {

Expected "if (...) {\n"; found "if(...) {\n"

                sleep($delay);
            }
        }
    }

    /**
     * Create Rows
     *
     * @param array $rows An array of arrays with the key as the field name and the value as the field value. E.g.

Expected 5 spaces after parameter name; 1 found

     * [

Parameter comment not aligned correctly; expected 20 spaces but found 1

     *      ['Field1' => 'Val1', 'Field2' => 'Val2'],

Parameter comment not aligned correctly; expected 20 spaces but found 6

     *      ['Field1' => 'Val3', 'Field2' => 'Val3']

Parameter comment not aligned correctly; expected 20 spaces but found 6

     * ]

Parameter comment not aligned correctly; expected 20 spaces but found 1

     * @param bool $typecast

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * 
     * @throws \GuzzleHttp\Exception\GuzzleException
     */

Missing @return tag in function comment

    public function createRows(array $rows, bool $typecast = true)
    {
        $data = [];
        foreach($rows as $row) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $data[] = ['fields' => $row];
        }
        
        $this->chunkAndThrottle($data, function($rowsToCreate) use ($typecast) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            $this->request('post', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                'records' => $rowsToCreate, 'typecast' => $typecast
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        });

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Delete Rows
     *
     * @param array $rowIds An array of row IDs to delete. E.g. ['rec123', 'rec456']
     *
     * @throws \GuzzleHttp\Exception\GuzzleException
     */

Missing @return tag in function comment

    public function deleteRows(array $rowIds)
    {
        $this->chunkAndThrottle($rowIds, function($rowIds) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            $this->request('delete', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                'records' => $rowIds
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        });

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    public function retrieveRecords()

Missing doc comment for function retrieveRecords()

    {
        $records = [];
        $offset = null;
        do {

Expected "do \n... while (...);\n"; found "do \n... while(...);\n"

            $response = $this->execute([], function($data) use ($offset) {

The parameter $data is not used and could be removed.

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                return $this->request('get', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'offset' => $offset
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            });

For multi-line function calls, the closing parenthesis should be on a new line.

            $responseData = json_decode($response->getBody()->getContents(), true);
            
            try {
                $newRecords = $responseData['records'];
            } catch (\Exception $e) {
                $newRecords = [];
            }
            
            $records = array_merge($records, $newRecords);
            if(array_key_exists('offset', $responseData)) {

Expected "if (...) {\n"; found "if(...) {\n"

                $offset = $responseData['offset'];
            } else {
                $offset = null;
            }
        } while($offset !== null);
        return $records;
    }
    
    public function getIdsFromTable(): array

Missing doc comment for function getIdsFromTable()

    {
         $ids = [];
        foreach($this->retrieveRecords() as $record) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $ids[] = $record['id'];
        }
        return $ids;
    }

    public function flushTable()

Missing doc comment for function flushTable()

    {
        $this->deleteRows(
            $this->getIdsFromTable()
        );
    }
    
}