User::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

User::paginate() A

↳ Parent: User

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\User as UserModel;
use BristolSU\ControlDB\Contracts\Repositories\User as UserContract;
use Illuminate\Support\Collection;

/**
 * Handles users
 */

class User implements UserContract
{

    /**
     * Get a user by ID
     *
     * @param int $id ID of the user

     * @return UserModel

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

    /**
     * Get all users
     *
     * @return Collection|UserModel[]
     */
    public function all(): Collection
    {
        return \BristolSU\ControlDB\Models\User::all();
    }

    /**
     * Create a new user
     *
     * @param int $dataProviderId

     * @return UserModel

     */
    public function create(int $dataProviderId): UserModel
    {
        return \BristolSU\ControlDB\Models\User::create([

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

    /**
     * Delete a user by ID
     *
     * @param int $id

     */

    public function delete(int $id): void
    {
        \BristolSU\ControlDB\Models\User::findOrFail($id)->delete();
    }

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

     * @return UserModel

     */
    public function getByDataProviderId(int $dataProviderId): UserModel {

        return \BristolSU\ControlDB\Models\User::where('data_provider_id', $dataProviderId)->firstOrFail();
    }

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

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

    /**
     * Get the number of users
     *
     * @return int
     */
    public function count(): int
    {
        return \BristolSU\ControlDB\Models\User::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		namespace BristolSU\ControlDB\Repositories;
4
5		use BristolSU\ControlDB\Contracts\Models\User as UserModel;
6		use BristolSU\ControlDB\Contracts\Repositories\User as UserContract;
7		use Illuminate\Support\Collection;
8
9		/**
10		* Handles users
11		*/
		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...
12		class User implements UserContract
13		{
14
15		/**
16		* Get a user by ID
17		*
18		* @param int $id ID of the user
		0 ignored issues – show 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...
19		* @return UserModel
		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...
20		*/
21	37	public function getById(int $id): UserModel
22		{
23	37	return \BristolSU\ControlDB\Models\User::findOrFail($id);
24		}
25
26		/**
27		* Get all users
28		*
29		* @return Collection\|UserModel[]
30		*/
31	3	public function all(): Collection
32		{
33	3	return \BristolSU\ControlDB\Models\User::all();
34		}
35
36		/**
37		* Create a new user
38		*
39		* @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...
40		* @return UserModel
		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...
41		*/
42	4	public function create(int $dataProviderId): UserModel
43		{
44	4	return \BristolSU\ControlDB\Models\User::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...
45	4	'data_provider_id' => $dataProviderId
46		]);
		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...
47		}
48
49		/**
50		* Delete a user by ID
51		*
52		* @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...
53		*/
		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...
54	2	public function delete(int $id): void
55		{
56	2	\BristolSU\ControlDB\Models\User::findOrFail($id)->delete();
57	2	}
58
59		/**
60		* Get a user by its data provider ID
61		*
62		* @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...
63		* @return UserModel
		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...
64		*/
65	4	public function getByDataProviderId(int $dataProviderId): UserModel {
		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...
66	4	return \BristolSU\ControlDB\Models\User::where('data_provider_id', $dataProviderId)->firstOrFail();
67		}
68
69		/**
70		* Paginate through all the users
71		*
72		* @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...
73		* @param int $perPage The number of results to return per page
74		*
75		* @return Collection\|UserModel[]
76		*/
77	3	public function paginate(int $page, int $perPage): Collection
78		{
79	3	return \BristolSU\ControlDB\Models\User::paginate($perPage, ['*'], 'page', $page)->getCollection();
80		}
81
82		/**
83		* Get the number of users
84		*
85		* @return int
86		*/
87	3	public function count(): int
88		{
89	3	return \BristolSU\ControlDB\Models\User::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\User::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...
90		}
91
92
93		}
94

bristol-su / control

GitHub Access Token became invalid

Pull Request — master (#13)

User::paginate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like