Role::paginate() - Code Metrics - Inspection of "v2.0" - bristol-su/control - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#13)

by Toby

created 2020-04-22 13:21 UTC

Role::paginate() A

↳ Parent: Role

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	2
crap	1

<?php



namespace BristolSU\ControlDB\Repositories;



use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleContract;
use Illuminate\Support\Collection;

/**
 * Class Role
 */

class Role implements RoleContract
{


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

     * @return RoleModel

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\Role
    {
        return \BristolSU\ControlDB\Models\Role::findOrFail($id);
    }

    /**
     * Get all roles
     *
     * @return Collection|\BristolSU\ControlDB\Contracts\Models\Role[]
     */
    public function all(): Collection
    {
        return \BristolSU\ControlDB\Models\Role::all();
    }

    /**
     * Create a new role
     *
     * @param int $positionId

     * @param int $groupId

     * @param int $dataProviderId

     * @return RoleModel

     */
    public function create(int $positionId, int $groupId, int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role
    {
        return \BristolSU\ControlDB\Models\Role::create([

            'position_id' => $positionId,
            'group_id' => $groupId,
            'data_provider_id' => $dataProviderId
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**
     * Delete a role
     *
     * @param int $id

     */

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

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

     * @return RoleModel

     */
    public function getByDataProviderId(int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role {

        return \BristolSU\ControlDB\Models\Role::where('data_provider_id', $dataProviderId)->firstOrFail();
    }
    
    /**
     * Get all roles that belong to the given group
     *
     * @param \BristolSU\ControlDB\Contracts\Models\Group $group

     * @return Collection|RoleModel[]

     */
    public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
    {
        return \BristolSU\ControlDB\Models\Role::where('group_id', $group->id())->get();
    }

    /**
     * Get all roles that belong to the given position
     * @param \BristolSU\ControlDB\Contracts\Models\Position $position

     * @return Collection|RoleModel[]

     */
    public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
    {
        return \BristolSU\ControlDB\Models\Role::where('position_id', $position->id())->get();
    }

    /**
     * Paginate through all the roles
     *
     * @param int $page The page number to return

     * @param int $perPage The number of results to return per page
     *
     * @return Collection|RoleModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return \BristolSU\ControlDB\Models\Role::paginate($perPage, ['*'], 'page', $page)->getCollection();
    }

    /**
     * Get the number of roles
     *
     * @return int
     */
    public function count(): int
    {
        return \BristolSU\ControlDB\Models\Role::count();

    }
}


1		<?php
2
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3
4		namespace BristolSU\ControlDB\Repositories;
5
6
7
8		use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
9		use BristolSU\ControlDB\Contracts\Repositories\Role as RoleContract;
10		use Illuminate\Support\Collection;
11
12		/**
13		* Class Role
14		*/
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
15		class Role implements RoleContract
16		{
17
18
19		/**
20		* Get a role by ID
21		*
22		* @param int $id
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
23		* @return RoleModel
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
24		*/
25	25	public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\Role
26		{
27	25	return \BristolSU\ControlDB\Models\Role::findOrFail($id);
28		}
29
30		/**
31		* Get all roles
32		*
33		* @return Collection\|\BristolSU\ControlDB\Contracts\Models\Role[]
34		*/
35	2	public function all(): Collection
36		{
37	2	return \BristolSU\ControlDB\Models\Role::all();
38		}
39
40		/**
41		* Create a new role
42		*
43		* @param int $positionId
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
44		* @param int $groupId
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
45		* @param int $dataProviderId
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
46		* @return RoleModel
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
47		*/
48	4	public function create(int $positionId, int $groupId, int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role
49		{
50	4	return \BristolSU\ControlDB\Models\Role::create([
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
51	4	'position_id' => $positionId,
52	4	'group_id' => $groupId,
53	4	'data_provider_id' => $dataProviderId
54		]);
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
55		}
56
57		/**
58		* Delete a role
59		*
60		* @param int $id
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
61		*/
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
62	2	public function delete(int $id): void
63		{
64	2	$this->getById($id)->delete();
65	2	}
66
67		/**
68		* Get a role by data provider ID
69		*
70		* @param int $dataProviderId
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
71		* @return RoleModel
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
72		*/
73	4	public function getByDataProviderId(int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role {
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Opening brace should be on a new line Loading history...
74	4	return \BristolSU\ControlDB\Models\Role::where('data_provider_id', $dataProviderId)->firstOrFail();
75		}
76
77		/**
78		* Get all roles that belong to the given group
79		*
80		* @param \BristolSU\ControlDB\Contracts\Models\Group $group
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
81		* @return Collection\|RoleModel[]
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
82		*/
83	4	public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
84		{
85	4	return \BristolSU\ControlDB\Models\Role::where('group_id', $group->id())->get();
86		}
87
88		/**
89		* Get all roles that belong to the given position
90		* @param \BristolSU\ControlDB\Contracts\Models\Position $position
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
91		* @return Collection\|RoleModel[]
		0 ignored issues – show Coding Style introduced 2020-01-29 23:13 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
92		*/
93	4	public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
94		{
95	4	return \BristolSU\ControlDB\Models\Role::where('position_id', $position->id())->get();
96		}
97
98		/**
99		* Paginate through all the roles
100		*
101		* @param int $page The page number to return
		0 ignored issues – show Coding Style introduced 2020-04-22 13:25 UTC by Report Bug Copy Issue Report Expected 4 spaces after parameter name; 1 found Loading history...
102		* @param int $perPage The number of results to return per page
103		*
104		* @return Collection\|RoleModel[]
105		*/
106	3	public function paginate(int $page, int $perPage): Collection
107		{
108	3	return \BristolSU\ControlDB\Models\Role::paginate($perPage, ['*'], 'page', $page)->getCollection();
109		}
110
111		/**
112		* Get the number of roles
113		*
114		* @return int
115		*/
116	3	public function count(): int
117		{
118	3	return \BristolSU\ControlDB\Models\Role::count();
		0 ignored issues – show Bug Best Practice introduced 2020-04-22 13:24 UTC by Report Bug Copy Issue Report The expression `return BristolSU\ControlDB\Models\Role::count()` could return the type `Illuminate\Database\Eloquent\Builder` which is incompatible with the type-hinted return `integer`. Consider adding an additional type-check to rule them out. Loading history...
119		}
120		}
121

bristol-su / control

GitHub Access Token became invalid

Pull Request — master (#13)

Role::paginate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like