bristol-su / control

src/Cache/Pivots/UserGroup.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Cache\Pivots;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup as UserGroupContract;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class UserGroup implements UserGroupContract

Missing doc comment for class UserGroup

{

    /**

Missing short description in doc comment

     * @var UserGroupContract
     */
    private $userGroup;

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

Missing doc comment for function __construct()

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

    /**
     * Get all users who are members of a group
     *
     * @param Group $group

Missing parameter comment

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

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

     */
    public function getUsersThroughGroup(Group $group): Collection
    {
        return $this->cache->rememberForever(static::class . '@getUsersThroughGroup:' . $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->userGroup->getUsersThroughGroup($group);
        });

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

    }

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

Missing parameter comment

     * @return Group[]|Collection Groups the user is a member of

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

     */
    public function getGroupsThroughUser(User $user): Collection
    {
        return $this->cache->rememberForever(static::class . '@getGroupsThroughUser:' . $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->userGroup->getGroupsThroughUser($user);
        });    

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

    }

    /**
     * Add a user to a group
     *
     * @param User $user User to add to the group

Expected 2 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 1 found

     * @param Group $group Group to add the user to
     * @return void

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

     */
    public function addUserToGroup(User $user, Group $group): void
    {
        $this->userGroup->addUserToGroup($user, $group);
    }

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

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

Expected 2 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 1 found

     * @param Group $group Group to remove the user from
     * @return void

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

     */
    public function removeUserFromGroup(User $user, Group $group): void
    {
        $this->userGroup->removeUserFromGroup($user, $group);
    }
}