Beachcasts\Airtable\Table

Complexity

Total Complexity

9

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Test Coverage

Coverage

57.58%

Importance

Changes	10
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	read()	0	3	1
A	list()	0	13	1
A	__construct()	0	4	1
A	setClient()	0	3	1
A	getName()	0	3	1
A	delete()	0	7	1
A	update()	0	14	2

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

    /**
     * @var string $viewName
     */
    protected $viewName;

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

    /**
     * @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): ResponseInterface

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

    {
        $params = [
            'maxRecords' => 3,
            'view' => $this->viewName
        ];

//        if (!empty($params))
        $queryString = http_build_query($params);

        $url = $this->tableName . '?' . $queryString;

        return $this->client->request('GET', $url);
    }

    /**
     * @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->request('GET', $this->tableName . '/' . $id);
    }

    /**
     * @todo split out to a replace method for PUT
     *
     * @param array $data
     * @param string $type accepts PUT to replace or PATCH to update records
     * @return mixed
     * @throws \Exception
     */
    public function update(array $data, $type = 'PATCH')
    {
        if (!in_array(strtolower($type), ['put', 'patch'])) {
            throw new \Exception('Invalid method type.');
        }

        return $this->client->request(
            strtoupper($type),
            $this->tableName,
            [
                'headers' => [
                    'Content-Type' => 'application/json',
                ],
                'body' => json_encode($data),
            ]
        );
    }

    /**
     * @param string $id
     * @return mixed
     */
    public function delete(string $id)
    {
        return $this->client->request(
            'DELETE',
            $this->tableName,
            [
                'query' => ['records[]' => $id],
            ]
        );
    }
}