bristol-su / control

src/Cache/Position.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache;

use BristolSU\ControlDB\Contracts\Models\Position as PositionModel;
use BristolSU\ControlDB\Contracts\Models\User as UserModel;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepositoryContract;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepository;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class Position implements PositionRepository

Missing doc comment for class Position

{
    /**

Missing short description in doc comment

     * @var PositionRepositoryContract
     */
    private $positionRepository;

Private member variable "positionRepository" 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(PositionRepositoryContract $positionRepository, Repository $cache)

Missing doc comment for function __construct()

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

    /**
     * Get a position by ID
     *
     * @param int $id ID of the position
     * @return PositionModel

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

     */
    public function getById(int $id): PositionModel
    {
        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->positionRepository->getById($id);
        });

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

    }

    /**
     * Get a position by its data provider ID
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return PositionModel

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

     */
    public function getByDataProviderId(int $dataProviderId): PositionModel
    {
        return $this->cache->rememberForever(static::class . '@getByDataProviderId:' . $dataProviderId, function() use ($dataProviderId) {

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->positionRepository->getByDataProviderId($dataProviderId);
        });

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

    }

    /**
     * Get all positions
     *
     * @return Collection|PositionModel[]
     */
    public function all(): Collection
    {
        return $this->positionRepository->all();
    }

    /**
     * Create a new position
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return PositionModel

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

     */
    public function create(int $dataProviderId): PositionModel
    {
        return $this->positionRepository->create($dataProviderId);
    }

    /**
     * Delete a position by ID
     *
     * @param int $id

Missing parameter comment

     */

Missing @return tag in function comment

    public function delete(int $id): void
    {
        $this->positionRepository->delete($id);
    }

    /**
     * Paginate through all the positions
     *
     * @param int $page The page number to return

Expected 4 spaces after parameter name; 1 found

     * @param int $perPage The number of results to return per page
     *
     * @return Collection|PositionModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return $this->positionRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of positions
     *
     * @return int
     */
    public function count(): int
    {
        return $this->cache->rememberForever(static::class . '@count', function() {

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->positionRepository->count();
        });

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

    }

    /**
     * Update the position model
     *
     * @param int $id

Missing parameter comment

     * @param int $dataProviderId New data provider ID
     * @return PositionModel

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

     */
    public function update(int $id, int $dataProviderId): PositionModel
    {
        return $this->positionRepository->update($id, $dataProviderId);
    }
}