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

Passed

Push — master ( 0c5c4d...5cc6ab )

by Toby

created 2020-04-27 14:28 UTC

Position::paginate() A

↳ Parent: Position

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	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
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\Position as PositionModel;
use BristolSU\ControlDB\Contracts\Models\User as UserModel;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepositoryContract;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepository;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Support\Collection;

class Position implements PositionRepository

{
    /**

     * @var PositionRepositoryContract
     */
    private $positionRepository;

    /**

     * @var Repository
     */
    private $cache;


    public function __construct(PositionRepositoryContract $positionRepository, Repository $cache)

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

    /**
     * Get a position by ID
     *
     * @param int $id ID of the position
     * @return PositionModel

     */
    public function getById(int $id): PositionModel
    {
        return $this->cache->rememberForever(static::class . '@getById:' . $id, function() use ($id) {

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

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

     * @return PositionModel

     */
    public function getByDataProviderId(int $dataProviderId): PositionModel
    {
        return $this->cache->rememberForever(static::class . '@getByDataProviderId:' . $dataProviderId, function() use ($dataProviderId) {

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

    /**
     * Get all positions
     *
     * @return Collection|PositionModel[]
     */
    public function all(): Collection
    {
        return $this->positionRepository->all();
    }

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

     * @return PositionModel

     */
    public function create(int $dataProviderId): PositionModel
    {
        return $this->positionRepository->create($dataProviderId);
    }

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

     */

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

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

     * @param int $perPage The number of results to return per page
     *
     * @return Collection|PositionModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return $this->positionRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of positions
     *
     * @return int
     */
    public function count(): int
    {
        return $this->cache->rememberForever(static::class . '@count', function() {

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

    /**
     * Update the position model
     *
     * @param int $id

     * @param int $dataProviderId New data provider ID
     * @return PositionModel

     */
    public function update(int $id, int $dataProviderId): PositionModel
    {
        return $this->positionRepository->update($id, $dataProviderId);
    }
}

1		<?php
2
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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\Position as PositionModel;
6		use BristolSU\ControlDB\Contracts\Models\User as UserModel;
7		use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepositoryContract;
8		use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepository;
9		use Illuminate\Contracts\Cache\Repository;
10		use Illuminate\Support\Collection;
11
12		class Position implements PositionRepository
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing doc comment for class Position Loading history...
13		{
14		/**
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
15		* @var PositionRepositoryContract
16		*/
17		private $positionRepository;
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Private member variable "positionRepository" must be prefixed with an underscore Loading history...
18		/**
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
19		* @var Repository
20		*/
21		private $cache;
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Private member variable "cache" must be prefixed with an underscore Loading history...
22
23	35	public function __construct(PositionRepositoryContract $positionRepository, Repository $cache)
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing doc comment for function __construct() Loading history...
24		{
25	35	$this->positionRepository = $positionRepository;
26	35	$this->cache = $cache;
27	35	}
28
29		/**
30		* Get a position by ID
31		*
32		* @param int $id ID of the position
33		* @return PositionModel
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
34		*/
35	19	public function getById(int $id): PositionModel
36		{
37		return $this->cache->rememberForever(static::class . '@getById:' . $id, function() use ($id) {
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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-04-24 16:49 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
38	19	return $this->positionRepository->getById($id);
39	19	});
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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...
40		}
41
42		/**
43		* Get a position by its data provider ID
44		*
45		* @param int $dataProviderId
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
46		* @return PositionModel
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
47		*/
48	3	public function getByDataProviderId(int $dataProviderId): PositionModel
49		{
50		return $this->cache->rememberForever(static::class . '@getByDataProviderId:' . $dataProviderId, function() use ($dataProviderId) {
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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-04-24 16:49 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
51	3	return $this->positionRepository->getByDataProviderId($dataProviderId);
52	3	});
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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...
53		}
54
55		/**
56		* Get all positions
57		*
58		* @return Collection\|PositionModel[]
59		*/
60	2	public function all(): Collection
61		{
62	2	return $this->positionRepository->all();
63		}
64
65		/**
66		* Create a new position
67		*
68		* @param int $dataProviderId
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
69		* @return PositionModel
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
70		*/
71	3	public function create(int $dataProviderId): PositionModel
72		{
73	3	return $this->positionRepository->create($dataProviderId);
74		}
75
76		/**
77		* Delete a position by ID
78		*
79		* @param int $id
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
80		*/
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
81	2	public function delete(int $id): void
82		{
83	2	$this->positionRepository->delete($id);
84	2	}
85
86		/**
87		* Paginate through all the positions
88		*
89		* @param int $page The page number to return
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Expected 4 spaces after parameter name; 1 found Loading history...
90		* @param int $perPage The number of results to return per page
91		*
92		* @return Collection\|PositionModel[]
93		*/
94	3	public function paginate(int $page, int $perPage): Collection
95		{
96	3	return $this->positionRepository->paginate($page, $perPage);
97		}
98
99		/**
100		* Get the number of positions
101		*
102		* @return int
103		*/
104	3	public function count(): int
105		{
106		return $this->cache->rememberForever(static::class . '@count', function() {
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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-04-24 16:49 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
107	3	return $this->positionRepository->count();
108	3	});
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 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...
109		}
110
111		/**
112		* Update the position model
113		*
114		* @param int $id
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
115		* @param int $dataProviderId New data provider ID
116		* @return PositionModel
		0 ignored issues – show Coding Style introduced 2020-04-24 16:49 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
117		*/
118	2	public function update(int $id, int $dataProviderId): PositionModel
119		{
120	2	return $this->positionRepository->update($id, $dataProviderId);
121		}
122		}

bristol-su / control

GitHub Access Token became invalid

Push — master ( 0c5c4d...5cc6ab )

Position::paginate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like