bristol-su / airtable

src/Progress/AirtableHandler.php

<?php

Missing file doc comment

namespace BristolSU\AirTable\Progress;

use BristolSU\AirTable\Jobs\CreateRecords;
use BristolSU\AirTable\Jobs\FlushRows;
use BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceRepository;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use BristolSU\Support\Progress\Handlers\Handler;
use BristolSU\Support\Progress\ModuleInstanceProgress;
use BristolSU\Support\Progress\Progress;
use Carbon\Carbon;
use Illuminate\Support\Facades\Log;

class AirtableHandler implements Handler

Missing doc comment for class AirtableHandler

{

    protected string $baseId;
    protected string $tableName;
    protected string $apiKey;
    private bool $debug;

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

    public function __construct(string $baseId, string $tableName, string $apiKey, bool $debug = false)

Missing doc comment for function __construct()

    {
        $this->baseId = $baseId;
        $this->tableName = $tableName;
        $this->apiKey = $apiKey;
        $this->debug = $debug;
    }

    protected function filterModules(\Closure $filter, Progress $progress, $moduleInstances)

Missing doc comment for function filterModules()

    {
        return collect($progress->getModules())
            ->filter($filter)->map(function (ModuleInstanceProgress $moduleInstanceProgress) use ($moduleInstances) {

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

                return $moduleInstances[$moduleInstanceProgress->getModuleInstanceId()];
            })->values()->toArray();

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

    }

    protected function parseProgress(Progress $progress)

Missing doc comment for function parseProgress()

    {
        $activityInstance = app(ActivityInstanceRepository::class)
            ->getById($progress->getActivityInstanceId());
        $moduleInstances = app(ModuleInstanceRepository::class)
            ->allThroughActivity($activityInstance->activity)
            ->reduce(function ($carry, ModuleInstance $moduleInstance) {

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

                $carry[$moduleInstance->id()] = $moduleInstance->name;
                return $carry;
            });

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

        return [
            'Participant Name' => $activityInstance->participantName(),
            'Mandatory Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return $moduleInstanceProgress->isMandatory();
            }, $progress, $moduleInstances),

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

            'Optional Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return !$moduleInstanceProgress->isMandatory();
            }, $progress, $moduleInstances),

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

            'Complete Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return $moduleInstanceProgress->isComplete();
            }, $progress, $moduleInstances),

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

            'Incomplete Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return !$moduleInstanceProgress->isComplete();
            }, $progress, $moduleInstances),

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

            'Active Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return $moduleInstanceProgress->isActive();
            }, $progress, $moduleInstances),

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

            'Inactive Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return !$moduleInstanceProgress->isActive();
            }, $progress, $moduleInstances),

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

            'Hidden Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return !$moduleInstanceProgress->isVisible();
            }, $progress, $moduleInstances),

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

            'Visible Modules' => $this->filterModules(function (ModuleInstanceProgress $moduleInstanceProgress) {

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

                return $moduleInstanceProgress->isVisible();
            }, $progress, $moduleInstances),

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

            '% Complete' => $progress->getPercentage(),
            'Activity Instance ID' => $activityInstance->id,
            'Activity ID' => $progress->getActivityId(),
            'Participant ID' => $activityInstance->resource_id,
            'Snapshot Date' => $progress->getTimestamp()->format(\DateTime::ATOM)
        ];

    }

    /**

Missing short description in doc comment

     * @param array|Progress[] $progresses

Missing parameter comment

     */

Missing @return tag in function comment

    public function saveMany(array $progresses): void
    {
        $data = [];
        $this->log(sprintf('Parsing %d progresses', count($progresses)));
        foreach ($progresses as $progress) {
            $data[] = $this->parseProgress($progress);
        }
        $this->createRecords($data);
    }

    public function save(Progress $progress): void

Missing doc comment for function save()

    {
        $this->saveMany([$progress]);
    }

    protected function createRecords(array $data)

Missing doc comment for function createRecords()

    {
        $this->log('Flushing rows');
        dispatch_now(
            (new FlushRows($this->apiKey, $this->baseId, $this->tableName))
                ->withDebug($this->debug)
        );
        
        $this->log('Flushed rows');
        
        foreach(array_chunk($data, 10) as $rows) {

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

            dispatch((new CreateRecords(

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

                $rows,
                $this->apiKey,
                $this->baseId,
                $this->tableName
            ))->withDebug($this->debug));

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

        }
        
        $this->log('Created Records');
    }

    private function log(string $string)

Private method name "AirtableHandler::log" must be prefixed with an underscore

Missing doc comment for function log()

    {
        if($this->debug) {

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

            Log::debug($string);
        }
    }
}