Beachcasts / airtable-sdk-php

src/Table.php

<?php
/**
 * Project airtable-sdk-php
 * File: Table.php
 * Created by: tpojka
 * On: 26/03/2020
 */

declare(strict_types=1);

namespace Beachcasts\Airtable;

use Beachcasts\Airtable\Request\TableRequest as TableRequest;
use GuzzleHttp\Client;
use Psr\Http\Message\ResponseInterface;

/**
 * Class Table
 * @package Beachcasts\Airtable
 */
class Table
{
    /**
     * @var string|null $tableName
     */
    protected $tableName;

    /**
     * @var Client $client
     */
    protected $client;

    /**
     * Table constructor.
     *
     * @param string $tableName
     */
    public function __construct(string $tableName)
    {
        $this->tableName = $tableName;
    }

    /**
     * @param Client $client
     */
    public function setClient(Client $client): void
    {
        $this->client = $client;
    }

    /**
     * @return string|null
     */
    public function getName(): ?string
    {
        return $this->tableName;
    }

    /**
     *
     * Params could include the following:
     *      fields = ['column_1_name', 'column_2_name', 'column_3_name]
     *      filterByFormula = "NOT({Headline} = '')"
     *      maxRecords = 100
     *      pageSize = 100
     *      sort = [{field: "Headline", direction: "desc"}]
     *      view = "view_name"
     *
     * @param array $params
     * @return ResponseInterface
     */
    public function list(array $params)
    {
        return $this->client->send(
            TableRequest::listRecords($this->getName(), $params)

It seems like $this->getName() can also be of type null; however, parameter $tableName of Beachcasts\Airtable\Request\TableRequest::listRecords() does only seem to accept string, maybe add an additional type check?

        );
    }

    /**
     * @param array $records
     * @return mixed
     */
    public function create(array $records)
    {
        return $this->client->send(
            TableRequest::createRecords($this->getName(), $records)

It seems like $this->getName() can also be of type null; however, parameter $tableName of Beachcasts\Airtable\Request\TableRequest::createRecords() does only seem to accept string, maybe add an additional type check?

        );
    }

    /**
     * @param string $id
     * @return mixed
     */
    public function read(string $id)
    {
        return $this->client->send(
            TableRequest::readRecords($this->tableName, $id)

It seems like $this->tableName can also be of type null; however, parameter $tableName of Beachcasts\Airtable\Request\TableRequest::readRecords() does only seem to accept string, maybe add an additional type check?

        );
    }

    /**
     * @param array $records
     * @param string $type accepts PUT to replace or PATCH to update records
     * @return mixed
     * @throws \Exception
     * @todo split out to a replace method for PUT
     *
     */
    public function update(array $records, $type = 'PATCH')
    {
        return $this->client->send(
            TableRequest::updateRecords($this->getName(), $records, $type)

It seems like $this->getName() can also be of type null; however, parameter $tableName of Beachcasts\Airtable\Request\TableRequest::updateRecords() does only seem to accept string, maybe add an additional type check?

        );
    }

    /**
     * @param array $records
     * @return mixed
     */
    public function delete(array $records)
    {
        return $this->client->send(
            TableRequest::deleteRecords($this->getName(), $records)

It seems like $this->getName() can also be of type null; however, parameter $tableName of Beachcasts\Airtable\Request\TableRequest::deleteRecords() does only seem to accept string, maybe add an additional type check?

        );
    }
}