bristol-su / control

src/Cache/Role.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache;

use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepositoryContract;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class Role implements RoleRepositoryContract

Missing doc comment for class Role

{

    /**

Missing short description in doc comment

     * @var RoleRepositoryContract
     */
    private $roleRepository;

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

Missing doc comment for function __construct()

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

    /**

Missing short description in doc comment

Parameter $id should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getById(int $id): RoleModel
    {
        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->roleRepository->getById($id);
        });

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

    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function all(): Collection
    {
        return $this->roleRepository->all();
    }

    /**

Missing short description in doc comment

Parameter $dataProviderId should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getByDataProviderId(int $dataProviderId): RoleModel
    {
        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->roleRepository->getByDataProviderId($dataProviderId);
        });

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

    }

    /**

Missing short description in doc comment

Parameter $positionId should have a doc-comment as per coding-style.

Parameter $groupId should have a doc-comment as per coding-style.

Parameter $dataProviderId should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function create(int $positionId, int $groupId, int $dataProviderId): RoleModel
    {
        return $this->roleRepository->create($positionId, $groupId, $dataProviderId);
    }

    /**

Missing short description in doc comment

Parameter $id should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

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

    /**

Missing short description in doc comment

Parameter $group should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
    {
        return $this->cache->rememberForever(static::class . '@allThroughGroup:' . $group->id(), function() use ($group) {

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->roleRepository->allThroughGroup($group);
        });

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

    }

    /**

Missing short description in doc comment

Parameter $position should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
    {
        return $this->cache->rememberForever(static::class . '@allThroughPosition:' . $position->id(), function() use ($position) {

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->roleRepository->allThroughPosition($position);
        });

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

    }

    /**
     * Paginate through all the roles
     *
     * @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|RoleModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return $this->roleRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of roles
     *
     * @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->roleRepository->count();
        });

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

        
    }

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

Missing parameter comment

     * @param int $positionId

Missing parameter comment

     * @param int $groupId

Missing parameter comment

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

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

     */
    public function update(int $id, int $positionId, int $groupId, int $dataProviderId): RoleModel
    {
        return $this->roleRepository->update($id, $positionId, $groupId, $dataProviderId);
    }
}