BristolSU\ControlDB\Repositories\Pivots\UserGroup

Complexity

Total Complexity

4

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getGroupsThroughUser()	0	9	1
A	addUserToGroup()	0	4	1
A	removeUserFromGroup()	0	5	1
A	getUsersThroughGroup()	0	9	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Repositories\Pivots;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Models\Pivots\UserGroup as UserGroupPivotModel;
use Illuminate\Support\Collection;

/**
 * Handle the relationship between a group and a user
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UserGroup implements \BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup
{

    /**
     * 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
    {
        $userRepository = app(\BristolSU\ControlDB\Contracts\Repositories\User::class);

        return UserGroupPivotModel::where('group_id', $group->id())->get()->map(function(UserGroupPivotModel $userGroup) use ($userRepository) {

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 $userRepository->getById((int) $userGroup->user_id);
        })->unique(function(User $user) {

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

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 $user->id();
        })->values();

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
    {
        $groupRepository = app(\BristolSU\ControlDB\Contracts\Repositories\Group::class);

        return UserGroupPivotModel::where('user_id', $user->id())->get()->map(function(UserGroupPivotModel $userGroup) use ($groupRepository) {

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 $groupRepository->getById((int) $userGroup->group_id);
        })->unique(function(Group $group) {

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

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 $group->id();
        })->values();

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
    {
        UserGroupPivotModel::create([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'user_id' => $user->id(), 'group_id' => $group->id()
        ]);

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

    }

    /**
     * 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
    {
        UserGroupPivotModel::where([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'user_id' => $user->id(), 'group_id' => $group->id()
        ])->delete();

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

    }
}