CriteriaController::toApiArray() - Code Metrics - Inspection of "Merge branch 'feature/job-builder/criteria-api' in..." - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/job-builder/skills-red... ( 72c86d )

by Tristan

created 2019-07-20 20:58 UTC

CriteriaController::toApiArray() A

↳ Parent: CriteriaController

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	1
crap	1

<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Criteria;
use App\Models\JobPoster;
use App\Models\AssessmentPlanNotification;
use App\Models\Assessment;
use Illuminate\Http\Request;

class CriteriaController extends Controller
{
/**
     * Converts a Criteria to the shape sent and recieved by the api.
     *
     * @param Criteria $model

     * @return void

     */
    public function toApiArray(Criteria $model)
    {
        return array_merge($model->toArray(), $model->getTranslationsArray());
    }

    /**
     * Get the set of criteria associated with a Job.
     *
     * @param JobPoster $jobPoster

     * @return \Illuminate\Http\Response
     */
    public function indexByJob(JobPoster $jobPoster)
    {
        $toApiArray = array($this, 'toApiArray');
        $criteriaAray = Criteria::where('job_poster_id', $jobPoster->id)->get()->map($toApiArray);
        return response()->json($criteriaAray);
    }

    /**
     * Update the set of criteria associated with a Job.
     *
     * @param Request $request

     * @param JobPoster $jobPoster

     * @return \Illuminate\Http\Response
     */
    public function batchUpdate(Request $request, JobPoster $jobPoster)
    {
        $toApiArray = array($this, 'toApiArray');

        $newCriteria = collect($request->input()); // TODO: switch to validated
        $oldCriteria = $jobPoster->criteria;

        $updatedIds = [];

        // First, delete old criteria that weren't resubmitted, and update those that were
        foreach ($oldCriteria as $criteria) {
            $newData = $newCriteria->firstWhere('id', $criteria['id']);
            if ($newData) {
                $updatedIds[] = $criteria->id;
                $this->updateCriteria($criteria, $newData);
            } else {
                $this->deleteCriteria($criteria);
            }
        }

        $isUnsaved = function ($criteria, $savedIds): bool {
            return !array_key_exists('id', $criteria) || !in_array($criteria['id'], $savedIds);
        };

        // Now, save any new criteria that remain
        foreach ($newCriteria as $criteriaData) {
            if ($isUnsaved($criteriaData, $updatedIds)) {
                $criteria = new Criteria();
                $criteria->job_poster_id = $jobPoster->id;
                $fillableData = collect($criteriaData)->except(['id', 'job_poster_id'])->toArray();
                $criteria->fill($fillableData);
                $this->createCriteria($criteria);
            }
        }

        $criteriaAray = Criteria::where('job_poster_id', $jobPoster->id)->get()->map($toApiArray);
        return response()->json($criteriaAray);
    }

    /**
     * Save a new criteria and create a notification.
     *
     * @param Criteria $criteria

     * @return void

     */
    protected function createCriteria(Criteria $criteria)
    {
        $criteria->save();

        $notification = $this->makeAssessmentPlanNotification(
            'CREATE',
            $criteria
        );
        $notification->save();

        return $criteria;
    }

    /**
     * Update an existing Job Criteria and create a notification if necessary.
     *
     * @param  \App\Models\Criteria $oldCriteria Existing Critera.
     * @param  mixed[] $newData Updated version of the Critera.

     * @return void
     */
    protected function updateCriteria(Criteria $oldCriteria, $newData): void

    {
        // We only need to create a notification when the non-descriptive fields change
        if ($oldCriteria->skill_level_id != $newData['skill_level_id']
            || $oldCriteria->skill_id != $newData['skill_id']
        ) {
            $notification = $this->makeAssessmentPlanNotification(
                'UPDATE',
                $oldCriteria,
                $newData['skill_id'],
                $newData['skill_level_id'],
                $newData['criteria_type_id']
            );
            $notification->save();
        }
        // Get just the data that can be changed
        $fillableData = collect($newData)->except(['id', 'job_poster_id'])->toArray();
        $oldCriteria->fill($fillableData);
        $oldCriteria->save();
    }

    /**
     * Delete existing Job Criteria and create a notification.
     *
     * @param  \App\Models\Criteria $criteria Incoming Criteria.
     * @return void
     */
    protected function deleteCriteria(Criteria $criteria): void
    {
        $notification = $notification = $this->makeAssessmentPlanNotification(

            'DELETE',
            $criteria
        );
        $notification->save();

        // Delete assessments related to this criteria.
        Assessment::where('criterion_id', $criteria->id)->delete();
        $criteria->delete();
    }

    /**
     * Create a new AssessmentPlanNotification for a modification to a Criteria
     *
     * @param  string               $type            Can be CREATE, UPDATE or DELETE.

     * @param  \App\Models\Criteria $criteria        The Criteria (the OLD criteria if updating or deleting)

     * @param  integer|null         $newSkillId      Only used for UPDATE type notifications.

     * @param  integer|null         $newSkillLevelId Only used for UPDATE type notifications.

     * @param  integer|null         $newCriteriaTypeId Only used for UPDATE type notifications.
     * @return \App\Models\AssessmentPlanNotification
     */
    protected function makeAssessmentPlanNotification(
        string $type,
        Criteria $criteria,
        $newSkillId = null,
        $newSkillLevelId = null,
        $newCriteriaTypeId = null
    ) {
        $notification = new AssessmentPlanNotification();
        $notification->job_poster_id = $criteria->job_poster_id;
        $notification->type = $type;
        $notification->criteria_id = $criteria->id;
        $notification->skill_id = $criteria->skill_id;
        $notification->criteria_type_id = $criteria->criteria_type_id;
        $notification->skill_level_id = $criteria->skill_level_id;
        $notification->skill_id_new = $newSkillId;
        $notification->skill_level_id_new = $newSkillLevelId;
        $notification->criteria_type_id_new = $newCriteriaTypeId;
        $notification->acknowledged = false;
        return $notification;
    }
}


1		<?php
2
3		namespace App\Http\Controllers\Api;
4
5		use App\Http\Controllers\Controller;
6		use App\Models\Criteria;
7		use App\Models\JobPoster;
8		use App\Models\AssessmentPlanNotification;
9		use App\Models\Assessment;
10		use Illuminate\Http\Request;
11
12		class CriteriaController extends Controller
13		{
14		/**
15		* Converts a Criteria to the shape sent and recieved by the api.
16		*
17		* @param Criteria $model
		1 ignored issue – show Coding Style Documentation introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
18		* @return void
		1 ignored issue – show Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Function return type is void, but function contains return statement Loading history...
19		*/
20	6	public function toApiArray(Criteria $model)
21		{
22	6	return array_merge($model->toArray(), $model->getTranslationsArray());
23		}
24
25		/**
26		* Get the set of criteria associated with a Job.
27		*
28		* @param JobPoster $jobPoster
		1 ignored issue – show Coding Style Documentation introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
29		* @return \Illuminate\Http\Response
30		*/
31	1	public function indexByJob(JobPoster $jobPoster)
32		{
33	1	$toApiArray = array($this, 'toApiArray');
34	1	$criteriaAray = Criteria::where('job_poster_id', $jobPoster->id)->get()->map($toApiArray);
35	1	return response()->json($criteriaAray);
36		}
37
38		/**
39		* Update the set of criteria associated with a Job.
40		*
41		* @param Request $request
		2 ignored issues – show Coding Style Documentation introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Expected 3 spaces after parameter type; 1 found Loading history...
42		* @param JobPoster $jobPoster
		1 ignored issue – show Coding Style Documentation introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
43		* @return \Illuminate\Http\Response
44		*/
45	5	public function batchUpdate(Request $request, JobPoster $jobPoster)
46		{
47	5	$toApiArray = array($this, 'toApiArray');
48
49	5	$newCriteria = collect($request->input()); // TODO: switch to validated
50	5	$oldCriteria = $jobPoster->criteria;
51
52	5	$updatedIds = [];
53
54		// First, delete old criteria that weren't resubmitted, and update those that were
55	5	foreach ($oldCriteria as $criteria) {
56	3	$newData = $newCriteria->firstWhere('id', $criteria['id']);
57	3	if ($newData) {
58	3	$updatedIds[] = $criteria->id;
59	3	$this->updateCriteria($criteria, $newData);
60		} else {
61	2	$this->deleteCriteria($criteria);
62		}
63		}
64
65		$isUnsaved = function ($criteria, $savedIds): bool {
66	5	return !array_key_exists('id', $criteria) \|\| !in_array($criteria['id'], $savedIds);
67	5	};
68
69		// Now, save any new criteria that remain
70	5	foreach ($newCriteria as $criteriaData) {
71	5	if ($isUnsaved($criteriaData, $updatedIds)) {
72	4	$criteria = new Criteria();
73	4	$criteria->job_poster_id = $jobPoster->id;
74	4	$fillableData = collect($criteriaData)->except(['id', 'job_poster_id'])->toArray();
75	4	$criteria->fill($fillableData);
76	4	$this->createCriteria($criteria);
77		}
78		}
79
80	5	$criteriaAray = Criteria::where('job_poster_id', $jobPoster->id)->get()->map($toApiArray);
81	5	return response()->json($criteriaAray);
82		}
83
84		/**
85		* Save a new criteria and create a notification.
86		*
87		* @param Criteria $criteria
		1 ignored issue – show Coding Style Documentation introduced 2019-04-08 22:10 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
88		* @return void
		1 ignored issue – show Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Function return type is void, but function contains return statement Loading history...
89		*/
90	4	protected function createCriteria(Criteria $criteria)
91		{
92	4	$criteria->save();
93
94	4	$notification = $this->makeAssessmentPlanNotification(
95	4	'CREATE',
96	4	$criteria
97		);
98	4	$notification->save();
99
100	4	return $criteria;
101		}
102
103		/**
104		* Update an existing Job Criteria and create a notification if necessary.
105		*
106		* @param \App\Models\Criteria $oldCriteria Existing Critera.
107		* @param mixed[] $newData Updated version of the Critera.
		2 ignored issues – show Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Expected 14 spaces after parameter type; 1 found Loading history... Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Expected 5 spaces after parameter name; 1 found Loading history...
108		* @return void
109		*/
110	3	protected function updateCriteria(Criteria $oldCriteria, $newData): void
		1 ignored issue – show Coding Style introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Type hint "array" missing for $newData Loading history...
111		{
112		// We only need to create a notification when the non-descriptive fields change
113	3	if ($oldCriteria->skill_level_id != $newData['skill_level_id']
114	3	\|\| $oldCriteria->skill_id != $newData['skill_id']
115		) {
116	2	$notification = $this->makeAssessmentPlanNotification(
117	2	'UPDATE',
118	2	$oldCriteria,
119	2	$newData['skill_id'],
120	2	$newData['skill_level_id'],
121	2	$newData['criteria_type_id']
122		);
123	2	$notification->save();
124		}
125		// Get just the data that can be changed
126	3	$fillableData = collect($newData)->except(['id', 'job_poster_id'])->toArray();
127	3	$oldCriteria->fill($fillableData);
128	3	$oldCriteria->save();
129	3	}
130
131		/**
132		* Delete existing Job Criteria and create a notification.
133		*
134		* @param \App\Models\Criteria $criteria Incoming Criteria.
135		* @return void
136		*/
137	2	protected function deleteCriteria(Criteria $criteria): void
138		{
139	2	$notification = $notification = $this->makeAssessmentPlanNotification(
		0 ignored issues – show Unused Code introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report The assignment to `$notification` is dead and can be removed. Loading history...
140	2	'DELETE',
141	2	$criteria
142		);
143	2	$notification->save();
144
145		// Delete assessments related to this criteria.
146	2	Assessment::where('criterion_id', $criteria->id)->delete();
147	2	$criteria->delete();
148	2	}
149
150		/**
151		* Create a new AssessmentPlanNotification for a modification to a Criteria
152		*
153		* @param string $type Can be CREATE, UPDATE or DELETE.
		1 ignored issue – show Coding Style introduced 2019-07-20 21:08 UTC by Report Bug Copy Issue Report Expected 14 spaces after parameter name; 12 found Loading history...
154		* @param \App\Models\Criteria $criteria The Criteria (the OLD criteria if updating or deleting)
		2 ignored issues – show Coding Style Documentation introduced 2019-07-20 20:50 UTC by Report Bug Copy Issue Report Parameter comment must end with a full stop Loading history... Coding Style introduced 2019-07-20 21:08 UTC by Report Bug Copy Issue Report Expected 10 spaces after parameter name; 8 found Loading history...
155		* @param integer\|null $newSkillId Only used for UPDATE type notifications.
		1 ignored issue – show Coding Style introduced 2019-07-20 21:08 UTC by Report Bug Copy Issue Report Expected 8 spaces after parameter name; 6 found Loading history...
156		* @param integer\|null $newSkillLevelId Only used for UPDATE type notifications.
		1 ignored issue – show Coding Style introduced 2019-07-20 21:08 UTC by Report Bug Copy Issue Report Expected 3 spaces after parameter name; 1 found Loading history...
157		* @param integer\|null $newCriteriaTypeId Only used for UPDATE type notifications.
158		* @return \App\Models\AssessmentPlanNotification
159		*/
160	5	protected function makeAssessmentPlanNotification(
161		string $type,
162		Criteria $criteria,
163		$newSkillId = null,
164		$newSkillLevelId = null,
165		$newCriteriaTypeId = null
166		) {
167	5	$notification = new AssessmentPlanNotification();
168	5	$notification->job_poster_id = $criteria->job_poster_id;
169	5	$notification->type = $type;
170	5	$notification->criteria_id = $criteria->id;
171	5	$notification->skill_id = $criteria->skill_id;
172	5	$notification->criteria_type_id = $criteria->criteria_type_id;
173	5	$notification->skill_level_id = $criteria->skill_level_id;
174	5	$notification->skill_id_new = $newSkillId;
175	5	$notification->skill_level_id_new = $newSkillLevelId;
176	5	$notification->criteria_type_id_new = $newCriteriaTypeId;
177	5	$notification->acknowledged = false;
178	5	return $notification;
179		}
180		}
181

GCTC-NTGC / TalentCloud

Push — feature/job-builder/skills-red... ( 72c86d )

CriteriaController::toApiArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like