BristolSU\ControlDB\Export\Handler\Airtable\IdRetriever

Complexity

Total Complexity

7

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	pushIds()	0	4	1
A	__construct()	0	5	1
A	saveIds()	0	6	2
A	ids()	0	4	1
A	key()	0	3	1
A	pushId()	0	5	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export\Handler\Airtable;


use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Export\FormattedItem;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class IdRetriever

Missing doc comment for class IdRetriever

{

    /**

Missing short description in doc comment

     * @var Repository
     */
    private Repository $cache;

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

    private $baseId;

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

    private $tableName;

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

    public function __construct(Repository $cache, $baseId, $tableName)

Missing doc comment for function __construct()

    {
        $this->cache = $cache;
        $this->baseId = $baseId;
        $this->tableName = $tableName;
    }

    public function ids(): Collection

Missing doc comment for function ids()

    {
        return collect(
            $this->cache->get($this->key())
        );
    }

    public function saveIds($ids)

Missing doc comment for function saveIds()

    {
        if($ids instanceof Collection) {

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

            $ids = $ids->toArray();
        }
        $this->cache->forever($this->key(), $ids);
    }
    
    public function pushIds(array $ids): void

Missing doc comment for function pushIds()

    {
        $currentIds = $this->ids();
        $this->saveIds($currentIds->concat($ids));
    }

    public function pushId(string $id): void

Missing doc comment for function pushId()

    {
        $currentIds = $this->ids();
        $currentIds->push($id);
        $this->saveIds($currentIds);
    }

    private function key()

Missing doc comment for function key()

Private method name "IdRetriever::key" must be prefixed with an underscore

    {
        return static::class . ':' . $this->baseId . ':' . $this->tableName;
    }

}