ReportsToController - Code Metrics - bkintanar/HRis - Measure and Improve Code Quality continuously with Scrutinizer

ReportsToController A
last analyzed 2017-01-28 06:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	232
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	4
lcom	1
cbo	1
dl	232
loc	232
ccs	10
cts	10
cp	1
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	5	5	1
A	store()	4	4	1
A	update()	4	4	1
A	destroy()	4	4	1

How to fix Duplicated Code

<?php

/*
 * This file is part of the HRis Software package.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the 3-clause BSD License.
 *
 * This source file is subject to the 3-clause BSD License that is
 * bundled with this package in the LICENSE file.
 *
 * @version    alpha
 *
 * @author     Bertrand Kintanar <[email protected]>
 * @license    BSD License (3-clause)
 * @copyright  (c) 2014-2016, b8 Studios, Ltd
 *
 * @link       http://github.com/HB-Co/HRis
 */

namespace HRis\Api\Controllers\Profile;

use HRis\Api\Requests\Profile\ReportsToRequest;
use Irradiate\Api\Controllers\BaseController;
use Irradiate\Eloquent\Employee;
use Irradiate\Eloquent\EmployeeSupervisor;
use Swagger\Annotations as SWG;

class ReportsToController extends BaseController

{
    /**
     * @var Employee
     */
    protected $employee;

    /**
     * @var EmployeeSupervisor
     */
    protected $employee_supervisor;

    /**
     * @param Employee           $employee
     * @param EmployeeSupervisor $employee_supervisor
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function __construct(Employee $employee, EmployeeSupervisor $employee_supervisor)
    {
        $this->employee = $employee;
        $this->employee_supervisor = $employee_supervisor;
    }

    /**
     * Stores a single instance of Employee Supervisor.
     *
     * @SWG\Post(
     *     path="/profile/reports-to",
     *     description="This route provides the ability to store a single instance of Employee Supervisor.",
     *     tags={"Employee Profiles"},
     *     consumes={"application/json"},
     *     summary="Stores a single instance of Employee Supervisor.",
     *     @SWG\Response(response="201", description="Success",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"supervisor", "message", "status_code"},
     *             @SWG\Property(property="supervisor", ref="#/definitions/Employee"),
     *             @SWG\Property(property="message", type="string", default="Record successfully added.", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=201, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Response(response="400", description="Token not provided",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code", "debug"},
     *             @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
     *             @SWG\Property(property="debug", type="object", description="Debug back trace"),
     *         )
     *     ),
     *     @SWG\Response(response="422", description="Unable to add record to the database.",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code"},
     *             @SWG\Property(property="message", type="string", default="Unable to add record to the database.", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Parameter(
     *         name="supervisor",
     *         in="body",
     *         required=true,
     *         @SWG\Property(ref="#/definitions/Employee")
     *     ),
     *     @SWG\Parameter(
     *         name="Authorization",
     *         in="header",
     *         description="JWT Token",
     *         required=true,
     *         type="string",
     *         default="Bearer "
     *     ),
     * )
     *
     * @param ReportsToRequest $request
     *
     * @return \Dingo\Api\Http\Response
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function store(ReportsToRequest $request)
    {
        return $this->storeModel($request, $this->employee_supervisor, 'supervisor');
    }

    /**
     * Updates a single instance of Employee Supervisor.
     *
     * @SWG\Patch(
     *     path="/profile/reports-to",
     *     description="This route provides the ability to update a single instance of Employee Supervisor.",
     *     tags={"Employee Profiles"},
     *     consumes={"application/json"},
     *     summary="Updates a single instance of Employee Supervisor.",
     *     @SWG\Response(response="200", description="Success",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code"},
     *             @SWG\Property(property="message", type="string", default="Record successfully updated.", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=200, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Response(response="400", description="Token not provided",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code", "debug"},
     *             @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
     *             @SWG\Property(property="debug", type="object", description="Debug back trace"),
     *         )
     *     ),
     *     @SWG\Response(response="404", description="Unable to retrieve record from database.",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code", "debug"},
     *             @SWG\Property(property="message", type="string", default="Unable to retrieve record from database.", description="Error message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
     *             @SWG\Property(property="debug", type="object", description="Debug back trace"),
     *         )
     *     ),
     *     @SWG\Response(response="422", description="Unable to update record.",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code"},
     *             @SWG\Property(property="message", type="string", default="Unable to update record.", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Parameter(
     *         name="supervisor",
     *         in="body",
     *         required=true,
     *         description="employee's supervisor object that needs to be updated",
     *         @SWG\Property(ref="#/definitions/Employee")
     *     ),
     *     @SWG\Parameter(
     *         name="Authorization",
     *         in="header",
     *         description="JWT Token",
     *         required=true,
     *         type="string",
     *         default="Bearer "
     *     ),
     * )
     *
     * @param ReportsToRequest $request
     *
     * @return \Dingo\Api\Http\Response
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function update(ReportsToRequest $request)
    {
        return $this->updateModel($request, $this->employee_supervisor);
    }

    /**
     * Deletes a single instance of EmployeeSupervisor.
     *
     * @SWG\Delete(
     *     path="/profile/reports-to/{employee_supervisor}",
     *     description="This route provides the ability to delete a EmployeeSupervisor.",
     *     tags={"Employee Profiles"},
     *     consumes={"application/json"},
     *     summary="Deletes a single instance of EmployeeSupervisor.",
     *     @SWG\Response(response="200", description="Success",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code"},
     *             @SWG\Property(property="message", type="string", default="Record successfully deleted.", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=200, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Response(response="400", description="Token not provided",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code", "debug"},
     *             @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
     *             @SWG\Property(property="debug", type="object", description="Debug back trace"),
     *         )
     *     ),
     *     @SWG\Response(response="422", description="422 Unprocessable Entity",
     *         @SWG\Schema(
     *             title="data",
     *             type="object",
     *             required={"message", "status_code"},
     *             @SWG\Property(property="message", type="string", default="422 Unprocessable Entity", description="Status message from server"),
     *             @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
     *         )
     *     ),
     *     @SWG\Parameter(
     *         name="employee_supervisor",
     *         in="path",
     *         description="Employee supervisor id to be deleted",
     *         required=true,
     *         type="integer",
     *         format="int64",
     *         default=1,
     *     ),
     *     @SWG\Parameter(
     *         name="Authorization",
     *         in="header",
     *         description="JWT Token",
     *         required=true,
     *         type="string",
     *         default="Bearer "
     *     ),
     * )
     *
     * @param EmployeeSupervisor $employee_supervisor
     * @param ReportsToRequest   $request
     *
     * @return \Dingo\Api\Http\Response
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function destroy(EmployeeSupervisor $employee_supervisor, ReportsToRequest $request)

    {
        return $this->destroyModel($employee_supervisor, $this->employee_supervisor);
    }
}


1			<?php
2
3			/*
4			* This file is part of the HRis Software package.
5			*
6			* NOTICE OF LICENSE
7			*
8			* Licensed under the 3-clause BSD License.
9			*
10			* This source file is subject to the 3-clause BSD License that is
11			* bundled with this package in the LICENSE file.
12			*
13			* @version alpha
14			*
15			* @author Bertrand Kintanar <[email protected]>
16			* @license BSD License (3-clause)
17			* @copyright (c) 2014-2016, b8 Studios, Ltd
18			*
19			* @link http://github.com/HB-Co/HRis
20			*/
21
22			namespace HRis\Api\Controllers\Profile;
23
24			use HRis\Api\Requests\Profile\ReportsToRequest;
25			use Irradiate\Api\Controllers\BaseController;
26			use Irradiate\Eloquent\Employee;
27			use Irradiate\Eloquent\EmployeeSupervisor;
28			use Swagger\Annotations as SWG;
29
30		View Code Duplication	class ReportsToController extends BaseController
			0 ignored issues – show Duplication introduced 2016-03-03 16:30 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
31			{
32			/**
33			* @var Employee
34			*/
35			protected $employee;
36
37			/**
38			* @var EmployeeSupervisor
39			*/
40			protected $employee_supervisor;
41
42			/**
43			* @param Employee $employee
44			* @param EmployeeSupervisor $employee_supervisor
45			*
46			* @author Bertrand Kintanar <[email protected]>
47			*/
48	10		public function __construct(Employee $employee, EmployeeSupervisor $employee_supervisor)
49			{
50	10		$this->employee = $employee;
51	10		$this->employee_supervisor = $employee_supervisor;
52	10		}
53
54			/**
55			* Stores a single instance of Employee Supervisor.
56			*
57			* @SWG\Post(
58			* path="/profile/reports-to",
59			* description="This route provides the ability to store a single instance of Employee Supervisor.",
60			* tags={"Employee Profiles"},
61			* consumes={"application/json"},
62			* summary="Stores a single instance of Employee Supervisor.",
63			* @SWG\Response(response="201", description="Success",
64			* @SWG\Schema(
65			* title="data",
66			* type="object",
67			* required={"supervisor", "message", "status_code"},
68			* @SWG\Property(property="supervisor", ref="#/definitions/Employee"),
69			* @SWG\Property(property="message", type="string", default="Record successfully added.", description="Status message from server"),
70			* @SWG\Property(property="status_code", type="integer", default=201, description="Status code from server"),
71			* )
72			* ),
73			* @SWG\Response(response="400", description="Token not provided",
74			* @SWG\Schema(
75			* title="data",
76			* type="object",
77			* required={"message", "status_code", "debug"},
78			* @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
79			* @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
80			* @SWG\Property(property="debug", type="object", description="Debug back trace"),
81			* )
82			* ),
83			* @SWG\Response(response="422", description="Unable to add record to the database.",
84			* @SWG\Schema(
85			* title="data",
86			* type="object",
87			* required={"message", "status_code"},
88			* @SWG\Property(property="message", type="string", default="Unable to add record to the database.", description="Status message from server"),
89			* @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
90			* )
91			* ),
92			* @SWG\Parameter(
93			* name="supervisor",
94			* in="body",
95			* required=true,
96			* @SWG\Property(ref="#/definitions/Employee")
97			* ),
98			* @SWG\Parameter(
99			* name="Authorization",
100			* in="header",
101			* description="JWT Token",
102			* required=true,
103			* type="string",
104			* default="Bearer "
105			* ),
106			* )
107			*
108			* @param ReportsToRequest $request
109			*
110			* @return \Dingo\Api\Http\Response
111			*
112			* @author Bertrand Kintanar <[email protected]>
113			*/
114	6		public function store(ReportsToRequest $request)
115			{
116	6		return $this->storeModel($request, $this->employee_supervisor, 'supervisor');
117			}
118
119			/**
120			* Updates a single instance of Employee Supervisor.
121			*
122			* @SWG\Patch(
123			* path="/profile/reports-to",
124			* description="This route provides the ability to update a single instance of Employee Supervisor.",
125			* tags={"Employee Profiles"},
126			* consumes={"application/json"},
127			* summary="Updates a single instance of Employee Supervisor.",
128			* @SWG\Response(response="200", description="Success",
129			* @SWG\Schema(
130			* title="data",
131			* type="object",
132			* required={"message", "status_code"},
133			* @SWG\Property(property="message", type="string", default="Record successfully updated.", description="Status message from server"),
134			* @SWG\Property(property="status_code", type="integer", default=200, description="Status code from server"),
135			* )
136			* ),
137			* @SWG\Response(response="400", description="Token not provided",
138			* @SWG\Schema(
139			* title="data",
140			* type="object",
141			* required={"message", "status_code", "debug"},
142			* @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
143			* @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
144			* @SWG\Property(property="debug", type="object", description="Debug back trace"),
145			* )
146			* ),
147			* @SWG\Response(response="404", description="Unable to retrieve record from database.",
148			* @SWG\Schema(
149			* title="data",
150			* type="object",
151			* required={"message", "status_code", "debug"},
152			* @SWG\Property(property="message", type="string", default="Unable to retrieve record from database.", description="Error message from server"),
153			* @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
154			* @SWG\Property(property="debug", type="object", description="Debug back trace"),
155			* )
156			* ),
157			* @SWG\Response(response="422", description="Unable to update record.",
158			* @SWG\Schema(
159			* title="data",
160			* type="object",
161			* required={"message", "status_code"},
162			* @SWG\Property(property="message", type="string", default="Unable to update record.", description="Status message from server"),
163			* @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
164			* )
165			* ),
166			* @SWG\Parameter(
167			* name="supervisor",
168			* in="body",
169			* required=true,
170			* description="employee's supervisor object that needs to be updated",
171			* @SWG\Property(ref="#/definitions/Employee")
172			* ),
173			* @SWG\Parameter(
174			* name="Authorization",
175			* in="header",
176			* description="JWT Token",
177			* required=true,
178			* type="string",
179			* default="Bearer "
180			* ),
181			* )
182			*
183			* @param ReportsToRequest $request
184			*
185			* @return \Dingo\Api\Http\Response
186			*
187			* @author Bertrand Kintanar <[email protected]>
188			*/
189	4		public function update(ReportsToRequest $request)
190			{
191	4		return $this->updateModel($request, $this->employee_supervisor);
192			}
193
194			/**
195			* Deletes a single instance of EmployeeSupervisor.
196			*
197			* @SWG\Delete(
198			* path="/profile/reports-to/{employee_supervisor}",
199			* description="This route provides the ability to delete a EmployeeSupervisor.",
200			* tags={"Employee Profiles"},
201			* consumes={"application/json"},
202			* summary="Deletes a single instance of EmployeeSupervisor.",
203			* @SWG\Response(response="200", description="Success",
204			* @SWG\Schema(
205			* title="data",
206			* type="object",
207			* required={"message", "status_code"},
208			* @SWG\Property(property="message", type="string", default="Record successfully deleted.", description="Status message from server"),
209			* @SWG\Property(property="status_code", type="integer", default=200, description="Status code from server"),
210			* )
211			* ),
212			* @SWG\Response(response="400", description="Token not provided",
213			* @SWG\Schema(
214			* title="data",
215			* type="object",
216			* required={"message", "status_code", "debug"},
217			* @SWG\Property(property="message", type="string", default="Token not provided", description="Error message from server"),
218			* @SWG\Property(property="status_code", type="integer", default=400, description="Status code from server"),
219			* @SWG\Property(property="debug", type="object", description="Debug back trace"),
220			* )
221			* ),
222			* @SWG\Response(response="422", description="422 Unprocessable Entity",
223			* @SWG\Schema(
224			* title="data",
225			* type="object",
226			* required={"message", "status_code"},
227			* @SWG\Property(property="message", type="string", default="422 Unprocessable Entity", description="Status message from server"),
228			* @SWG\Property(property="status_code", type="integer", default=422, description="Status code from server"),
229			* )
230			* ),
231			* @SWG\Parameter(
232			* name="employee_supervisor",
233			* in="path",
234			* description="Employee supervisor id to be deleted",
235			* required=true,
236			* type="integer",
237			* format="int64",
238			* default=1,
239			* ),
240			* @SWG\Parameter(
241			* name="Authorization",
242			* in="header",
243			* description="JWT Token",
244			* required=true,
245			* type="string",
246			* default="Bearer "
247			* ),
248			* )
249			*
250			* @param EmployeeSupervisor $employee_supervisor
251			* @param ReportsToRequest $request
252			*
253			* @return \Dingo\Api\Http\Response
254			*
255			* @author Bertrand Kintanar <[email protected]>
256			*/
257	2		public function destroy(EmployeeSupervisor $employee_supervisor, ReportsToRequest $request)
			0 ignored issues – show Unused Code introduced 2016-04-16 10:46 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
258			{
259	2		return $this->destroyModel($employee_supervisor, $this->employee_supervisor);
260			}
261			}
262

bkintanar / HRis

ReportsToController A last analyzed 2017-01-28 06:16 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ReportsToController A
last analyzed 2017-01-28 06:16 UTC