Role::paginate() - Code Metrics - Inspection of "Merge pull request #13 from bristol-su/develop" - bristol-su/control - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 348781...c5b82c )

by Toby

created 2020-04-22 13:29 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\Cache;

use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepositoryContract;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class Role implements RoleRepositoryContract

{

    /**

     * @var RoleRepositoryContract
     */
    private $roleRepository;

    /**

     * @var Repository
     */
    private $cache;


    public function __construct(RoleRepositoryContract $roleRepository, Repository $cache)

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

    /**

     * @inheritDoc
     */

    public function getById(int $id): RoleModel
    {
        return $this->cache->remember(static::class . '@getById:' . $id, 5000, function() use ($id) {

            return $this->roleRepository->getById($id);
        });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**

     * @inheritDoc
     */

    public function all(): Collection
    {
        return $this->roleRepository->all();
    }

    /**

     * @inheritDoc
     */

    public function getByDataProviderId(int $dataProviderId): RoleModel
    {
        return $this->cache->remember(static::class . '@getByDataProviderId:' . $dataProviderId, 5000, function() use ($dataProviderId) {

            return $this->roleRepository->getByDataProviderId($dataProviderId);
        });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**

     * @inheritDoc
     */

    public function create(int $positionId, int $groupId, int $dataProviderId): RoleModel
    {
        return $this->roleRepository->create($positionId, $groupId, $dataProviderId);
    }

    /**

     * @inheritDoc
     */

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

    /**

     * @inheritDoc
     */

    public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
    {
        return $this->roleRepository->allThroughGroup($group);
    }

    /**

     * @inheritDoc
     */

    public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
    {
        return $this->roleRepository->allThroughPosition($position);
    }

    /**
     * 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 $this->roleRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of roles
     *
     * @return int
     */
    public function count(): int
    {
        return $this->roleRepository->count();
    }
}

1		<?php
2
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3		namespace BristolSU\ControlDB\Cache;
4
5		use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
6		use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepositoryContract;
7		use Illuminate\Contracts\Cache\Repository;
8		use Illuminate\Support\Collection;
9
10		class Role implements RoleRepositoryContract
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing doc comment for class Role Loading history...
11		{
12
13		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
14		* @var RoleRepositoryContract
15		*/
16		private $roleRepository;
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Private member variable "roleRepository" must be prefixed with an underscore Loading history...
17		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
18		* @var Repository
19		*/
20		private $cache;
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Private member variable "cache" must be prefixed with an underscore Loading history...
21
22	35	public function __construct(RoleRepositoryContract $roleRepository, Repository $cache)
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing doc comment for function __construct() Loading history...
23		{
24	35	$this->roleRepository = $roleRepository;
25	35	$this->cache = $cache;
26	35	}
27
28		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$id` should have a doc-comment as per coding-style. Loading history...
29		* @inheritDoc
30		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
31	22	public function getById(int $id): RoleModel
32		{
33		return $this->cache->remember(static::class . '@getById:' . $id, 5000, function() use ($id) {
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 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... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
34	22	return $this->roleRepository->getById($id);
35	22	});
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 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...
36		}
37
38		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
39		* @inheritDoc
40		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
41	1	public function all(): Collection
42		{
43	1	return $this->roleRepository->all();
44		}
45
46		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$dataProviderId` should have a doc-comment as per coding-style. Loading history...
47		* @inheritDoc
48		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
49	2	public function getByDataProviderId(int $dataProviderId): RoleModel
50		{
51		return $this->cache->remember(static::class . '@getByDataProviderId:' . $dataProviderId, 5000, function() use ($dataProviderId) {
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 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... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
52	2	return $this->roleRepository->getByDataProviderId($dataProviderId);
53	2	});
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 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...
54		}
55
56		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$positionId` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$groupId` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$dataProviderId` should have a doc-comment as per coding-style. Loading history...
57		* @inheritDoc
58		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
59	2	public function create(int $positionId, int $groupId, int $dataProviderId): RoleModel
60		{
61	2	return $this->roleRepository->create($positionId, $groupId, $dataProviderId);
62		}
63
64		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$id` should have a doc-comment as per coding-style. Loading history...
65		* @inheritDoc
66		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
67	1	public function delete(int $id): void
68		{
69	1	$this->roleRepository->delete($id);
70	1	}
71
72		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$group` should have a doc-comment as per coding-style. Loading history...
73		* @inheritDoc
74		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
75	3	public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
76		{
77	3	return $this->roleRepository->allThroughGroup($group);
78		}
79
80		/**
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Parameter `$position` should have a doc-comment as per coding-style. Loading history...
81		* @inheritDoc
82		*/
		0 ignored issues – show Coding Style introduced 2020-03-31 23:03 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
83	3	public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
84		{
85	3	return $this->roleRepository->allThroughPosition($position);
86		}
87
88		/**
89		* Paginate through all the roles
90		*
91		* @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...
92		* @param int $perPage The number of results to return per page
93		*
94		* @return Collection\|RoleModel[]
95		*/
96	2	public function paginate(int $page, int $perPage): Collection
97		{
98	2	return $this->roleRepository->paginate($page, $perPage);
99		}
100
101		/**
102		* Get the number of roles
103		*
104		* @return int
105		*/
106	2	public function count(): int
107		{
108	2	return $this->roleRepository->count();
109		}
110		}

bristol-su / control

GitHub Access Token became invalid

Push — master ( 348781...c5b82c )

Role::paginate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like