bristol-su / control

src/Cache/DataRole.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache;

use BristolSU\ControlDB\Contracts\Repositories\DataRole as DataRoleRepository;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class DataRole implements DataRoleRepository

Missing doc comment for class DataRole

{

    /**

Missing short description in doc comment

     * @var DataRoleRepository
     */
    private $dataRoleRepository;

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

Missing doc comment for function __construct()

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

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

Missing parameter comment

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

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

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        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->dataRoleRepository->getById($id);
        });

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

    }

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

Missing parameter comment

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

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

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

Missing parameter comment

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

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

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

    /**
     * Create a data position with the given attributes
     *
     * @param string|null $roleName Custom name for the role
     * @param string|null $email Email of the role

Expected 4 spaces after parameter name; 1 found

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

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

     */
    public function create(?string $roleName = null, ?string $email = null): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        return $this->dataRoleRepository->create($roleName, $email);
    }

    /**
     * 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 $roleName Custom name for the role
     * @param string|null $email Email of the role

Expected 4 spaces after parameter name; 1 found

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

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

     */
    public function update(int $id, ?string $roleName = null, ?string $email = null): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        return $this->dataRoleRepository->update($id, $roleName, $email);
    }
}