bristol-su / control

src/Cache/DataPosition.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache;

use BristolSU\ControlDB\Contracts\Repositories\DataPosition as DataPositionRepository;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class DataPosition implements DataPositionRepository

Missing doc comment for class DataPosition

{

    /**

Missing short description in doc comment

     * @var DataPositionRepository
     */
    private $dataPositionRepository;

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

    /**

Missing short description in doc comment

     * @var Repository
     */
    private $cache;

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

    public function __construct(DataPositionRepository $dataPositionRepository, Repository $cache)

Missing doc comment for function __construct()

    {
        $this->dataPositionRepository = $dataPositionRepository;
        $this->cache = $cache;
    }

    /**
     * Get a data position by ID
     *
     * @param int $id

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataPosition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\DataPosition
    {
        return $this->cache->rememberForever(static::class . '@getById:' . $id, function() use ($id) {

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->dataPositionRepository->getById($id);
        });

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

    }

    /**
     * Get a data position where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataPosition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getWhere($attributes = []): \BristolSU\ControlDB\Contracts\Models\DataPosition
    {
        return $this->dataPositionRepository->getWhere($attributes);
    }
    
    /**
     * Get all data positions where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return Collection|\BristolSU\ControlDB\Contracts\Models\DataPosition[]

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getAllWhere($attributes = []): Collection
    {
        return $this->dataPositionRepository->getAllWhere($attributes);
    }


    /**
     * Create a data position with the given attributes
     *
     * @param string|null $name Name of the position

Expected 8 spaces after parameter name; 1 found

     * @param string|null $description Description of the position
     * @return \BristolSU\ControlDB\Contracts\Models\DataPosition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function create(?string $name = null, ?string $description = null): \BristolSU\ControlDB\Contracts\Models\DataPosition
    {
        return $this->dataPositionRepository->create($name, $description);
    }

    /**
     * Update a data position with the given attributes
     *
     * @param int $id

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

     * @param string|null $name Name of the position

Expected 8 spaces after parameter name; 1 found

     * @param string|null $description Description of the position
     * @return \BristolSU\ControlDB\Contracts\Models\DataPosition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function update(int $id, ?string $name = null, ?string $description = null): \BristolSU\ControlDB\Contracts\Models\DataPosition
    {
        return $this->dataPositionRepository->update($id, $name, $description);
    }
}