bristol-su / control

src/Cache/Pivots/UserRole.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache\Pivots;

use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole as UserRoleContract;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class UserRole implements UserRoleContract

Missing doc comment for class UserRole

{

    /**

Missing short description in doc comment

     * @var UserRoleContract
     */
    private $userRole;

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

Missing doc comment for function __construct()

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

    /**
     * Get all users who are members of a role
     *
     * @param Role $role

Missing parameter comment

     * @return User[]|Collection Users who are members of the role

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

     */
    public function getUsersThroughRole(Role $role): Collection
    {
        return $this->cache->rememberForever(static::class . '@getUsersThroughRole:' . $role->id(), function() use ($role) {

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->userRole->getUsersThroughRole($role);
        });

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

    }

    /**
     * Get all roles a user belongs to
     *
     * @param User $user

Missing parameter comment

     * @return Role[]|Collection Roles the user is a member of

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

     */
    public function getRolesThroughUser(User $user): Collection
    {
        return $this->cache->rememberForever(static::class . '@getRolesThroughUser:' . $user->id(), function() use ($user) {

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->userRole->getRolesThroughUser($user);
        });

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

    }

    /**
     * Add a user to a role
     *
     * @param User $user User to add to the role
     * @param Role $role Role to add the user to
     * @return void

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

     */
    public function addUserToRole(User $user, Role $role): void
    {
        $this->userRole->addUserToRole($user, $role);
    }

    /**
     * Remove a user from a role
     * @param User $user User to remove from the role

There must be exactly one blank line before the tags in a doc comment

     * @param Role $role Role to remove the user from
     * @return void

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

     */
    public function removeUserFromRole(User $user, Role $role): void
    {
        $this->userRole->removeUserFromRole($user, $role);
    }
    
}