App\Http\Controllers\ExperienceController::update()

Complexity

Conditions	17
Paths	1728

Size

Total Lines	181
Code Lines	93

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	306

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	setAttrFromInputOld()	0	19	8
A	getModelFromArrayOrSetNew()	0	9	3
A	get()	0	2	2
A	setAttrFromInputNew()	0	6	4

<?php

Missing file doc comment

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Lang;
use Illuminate\Http\Request;
use Barryvdh\Debugbar\Facade as Debugbar;
use App\Models\Degree;
use App\Models\Applicant;
use App\Models\Course;
use App\Models\WorkExperience;
use App\Models\Lookup\DegreeType;
use App\Models\Lookup\CourseStatus;
use App\Http\Controllers\Controller;

class ExperienceController extends Controller

Missing doc comment for class ExperienceController

{

    /**
     * Display the Experience page associated with the applicant.
     *
     * @param  \App\Models\Applicant  $applicant

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function show(Applicant $applicant)

The parameter $applicant is not used and could be removed.

    {
        //
    }

    /**
     * Show the form for editing the applicant's experience
     *
     * @param  Request  $request

Missing parameter comment

Expected 15 spaces after parameter type; 2 found

     * @param  \App\Models\Applicant  $applicant

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function edit(Request $request, Applicant $applicant)
    {
        return view('applicant/profile_02_experience', [

The expression return view('applicant/profile_02_experience', array('applicant' => $applicant, 'profile' => Illuminate\Support\Facades\Lang::get('applicant/profile_experience'), 'degree_types' => App\Models\Lookup\DegreeType::all(), 'course_status' => App\Models\Lookup\CourseStatus::all(), 'degree_template' => Illuminate\Support\Facades\Lang::get('common/degree'), 'course_template' => Illuminate\Support\Facades\Lang::get('common/course'), 'work_template' => Illuminate\Support\Facades\Lang::get('common/work_experience'), 'form_submit_action' => route('profile.experience.update', $applicant))) returns the type Illuminate\View\View which is incompatible with the documented return type Illuminate\Http\Response.

The opening parenthesis of a multi-line function call should be the last content on the line.

            'applicant' => $applicant,
            'profile' => Lang::get('applicant/profile_experience'),
            'degree_types' => DegreeType::all(),
            'course_status' => CourseStatus::all(),
            'degree_template' => Lang::get('common/degree'),
            'course_template' => Lang::get('common/course'),
            'work_template' => Lang::get('common/work_experience'),
            'form_submit_action' => route('profile.experience.update', $applicant)
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * Update the applicant's profile in storage.
     *
     * @param  \Illuminate\Http\Request  $request

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  \App\Models\Applicant  $applicant

Missing parameter comment

Expected 4 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function update(Request $request, Applicant $applicant)
    {
        $input = $request->input();

        $newDegrees = [];
        $newCourses = [];
        $newWorkExperiences = [];

        $oldDegrees = [];
        $oldCourses = [];
        $oldWorkExperiences = [];

        /**

Parameter $applicant should have a doc-comment as per coding-style.

         * If an obj exists at $array[$key], return it.
         * Otherwise, set $array[$key] to be a new instance of $class,
         * set applicant_id, and return it.
         *
         * @param  [type] $array [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

         * @param  [type] $key   [description]
         * @param  [type] $class [description]
         * @return [type]        [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

Tag cannot be grouped with parameter tags in a doc comment

         */
        function getModelFromArrayOrSetNew(&$array, $key, $class, $applicant) {

Opening brace should be on a new line

            if (isset($array[$key]) && $array[$key] != null ) {
                $obj = $array[$key];
            } else {
                $obj = new $class;
                $obj->applicant_id = $applicant->id;
                $array[$key] = $obj;
            }
            return $obj;
        }

        /**

Parameter $applicant should have a doc-comment as per coding-style.

         * For each item in an array, create a new model instance and set the
         * specified attribute with the value in the array.
         *
         * If an instance alread exists in the $instances array that matches
         * the $inputArray key, then set the attribute on that instance instead
         * of creating a new instance.
         *
         * @param array $inputArray An array of input key-values

Expected 37 spaces after parameter type; 1 found

         * @param array $instances    Array of previously created Model instances.

Expected 37 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 4 found

         * @param string $model      Fully qualified class name.

Expected 36 spaces after parameter type; 1 found

         * @param string $attribute  Name of attribute to set in model.

Expected 36 spaces after parameter type; 1 found

         * @param \App\Models\Applicant Owner of the object

The type App\Http\Controllers\Owner was not found. Maybe you did not declare it correctly or list all dependencies?

Missing parameter name

         */

Missing @return tag in function comment

        function setAttrFromInputNew($inputArray, &$instances, $model, $attribute, $applicant) {

It is generally recommended to explicitly declare the visibility for methods.

Opening brace should be on a new line

            if (isset($inputArray) && is_array($inputArray)) {
                foreach($inputArray as $key => $value) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    $obj = getModelFromArrayOrSetNew($instances, $key, $model, $applicant);
                    $obj->setAttribute($attribute, $value);
                    Debugbar::info($instances);
                }
            }
        }

        /**

Parameter $input should have a doc-comment as per coding-style.

Parameter $inputField should have a doc-comment as per coding-style.

Parameter $applicant should have a doc-comment as per coding-style.

         * For each item in an input array, retrieve the modelName instance with
         * id matching input key, and belonging to $applicant, and set $attribute
         * on that model instance with the inputArray value.
         *
         * Retrieved instances are cached in $instances array, so they don't
         * have to be retrieved from database multiple times.
         *
         * @param [type] $inputArray [description]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

Doc comment for parameter $inputArray does not match actual variable name $input

         * @param [type] $instances  [description]

Doc comment for parameter $instances does not match actual variable name $inputField

         * @param [type] $modelName  [description]

Doc comment for parameter $modelName does not match actual variable name $instances

         * @param [type] $attribute  [description]

Doc comment for parameter $attribute does not match actual variable name $modelName

         */

Missing @return tag in function comment

        function setAttrFromInputOld($input, $inputField, &$instances, $modelName, $attribute, $applicant) {

It is generally recommended to explicitly declare the visibility for methods.

Opening brace should be on a new line

            if (isset($input[$inputField]) &&
                is_array($input[$inputField]) &&

Each line in a multi-line IF statement must begin with a boolean operator

                isset($input[$inputField]['old']) &&

Each line in a multi-line IF statement must begin with a boolean operator

                is_array($input[$inputField]['old']) ) {

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                $inputArray = $input[$inputField]['old'];
                Debugbar::info($inputArray);
                foreach($inputArray as $key => $value) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                    if (isset($instances[$key])) {
                        $obj = $instances[$key];
                    } else {
                        $model = new $modelName;
                        $obj = $model->newQuery()->where('applicant_id', $applicant->id)
                            ->where('id', $key)->first();
                        $instances[$key] = $obj;
                    }
                    if ($obj != null) {
                        $obj->setAttribute($attribute, $value);
                    }
                }
            }
        }

        function get(&$var, $default=null) {

It is generally recommended to explicitly declare the visibility for methods.

Missing doc comment for function get()

Opening brace should be on a new line

            return isset($var) ? $var : $default;
        }

        // New Entitities
        setAttrFromInputNew(get($input['degree_type']['new']), $newDegrees,'App\Models\Degree', 'degree_type_id', $applicant);
        setAttrFromInputNew(get($input['degree_area']['new']), $newDegrees,'App\Models\Degree', 'area_of_study', $applicant);
        setAttrFromInputNew(get($input['degree_institution']['new']), $newDegrees,'App\Models\Degree', 'institution', $applicant);
        setAttrFromInputNew(get($input['degree_thesis']['new']), $newDegrees,'App\Models\Degree', 'thesis', $applicant);
        setAttrFromInputNew(get($input['degree_start_date']['new']), $newDegrees,'App\Models\Degree', 'start_date', $applicant);
        setAttrFromInputNew(get($input['degree_end_date']['new']), $newDegrees,'App\Models\Degree', 'end_date', $applicant);

        setAttrFromInputNew(get($input['course_name']['new']), $newCourses,'App\Models\Course', 'name', $applicant);
        setAttrFromInputNew(get($input['course_institution']['new']), $newCourses,'App\Models\Course', 'institution', $applicant);
        setAttrFromInputNew(get($input['course_status']['new']), $newCourses,'App\Models\Course', 'course_status_id', $applicant);
        setAttrFromInputNew(get($input['course_start_date']['new']), $newCourses,'App\Models\Course', 'start_date', $applicant);
        setAttrFromInputNew(get($input['course_end_date']['new']), $newCourses,'App\Models\Course', 'end_date', $applicant);

        setAttrFromInputNew(get($input['work_role']['new']), $newWorkExperiences,'App\Models\WorkExperience', 'role', $applicant);
        setAttrFromInputNew(get($input['work_company']['new']), $newWorkExperiences,'App\Models\WorkExperience', 'company', $applicant);
        setAttrFromInputNew(get($input['work_description']['new']), $newWorkExperiences,'App\Models\WorkExperience', 'description', $applicant);
        setAttrFromInputNew(get($input['work_start_date']['new']), $newWorkExperiences,'App\Models\WorkExperience', 'start_date', $applicant);
        setAttrFromInputNew(get($input['work_end_date']['new']), $newWorkExperiences,'App\Models\WorkExperience', 'end_date', $applicant);

        // PreExisting entities
        setAttrFromInputOld($input, 'degree_type', $oldDegrees,'App\Models\Degree', 'degree_type_id', $applicant);
        setAttrFromInputOld($input, 'degree_area', $oldDegrees,'App\Models\Degree', 'area_of_study', $applicant);
        setAttrFromInputOld($input, 'degree_institution', $oldDegrees,'App\Models\Degree', 'institution', $applicant);
        setAttrFromInputOld($input, 'degree_thesis', $oldDegrees,'App\Models\Degree', 'thesis', $applicant);
        setAttrFromInputOld($input, 'degree_start_date', $oldDegrees,'App\Models\Degree', 'start_date', $applicant);
        setAttrFromInputOld($input, 'degree_end_date', $oldDegrees,'App\Models\Degree', 'end_date', $applicant);

        setAttrFromInputOld($input, 'course_name', $oldCourses,'App\Models\Course', 'name', $applicant);
        setAttrFromInputOld($input, 'course_institution', $oldCourses,'App\Models\Course', 'institution', $applicant);
        setAttrFromInputOld($input, 'course_status', $oldCourses,'App\Models\Course', 'course_status_id', $applicant);
        setAttrFromInputOld($input, 'course_start_date', $oldCourses,'App\Models\Course', 'start_date', $applicant);
        setAttrFromInputOld($input, 'course_end_date', $oldCourses,'App\Models\Course', 'end_date', $applicant);

        setAttrFromInputOld($input, 'work_role', $oldWorkExperiences,'App\Models\WorkExperience', 'role', $applicant);
        setAttrFromInputOld($input, 'work_company', $oldWorkExperiences,'App\Models\WorkExperience', 'company', $applicant);
        setAttrFromInputOld($input, 'work_description', $oldWorkExperiences,'App\Models\WorkExperience', 'description', $applicant);
        setAttrFromInputOld($input, 'work_start_date', $oldWorkExperiences,'App\Models\WorkExperience', 'start_date', $applicant);
        setAttrFromInputOld($input, 'work_end_date', $oldWorkExperiences,'App\Models\WorkExperience', 'end_date', $applicant);

        //Delete old entities that weren't resubmitted
        foreach($applicant->degrees as $degree) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            Debugbar::info($oldCourses);
            Debugbar::info($degree);
            if (!isset($oldDegrees[$degree->id]) || $oldDegrees[$degree->id] === null) {
                Debugbar::info('Deleting degree ' . $degree->id);
                $degree->delete();
            }
        }
        foreach($applicant->courses as $course) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (!isset($oldCourses[$course->id]) || $oldCourses[$course->id] === null) {
                $course->delete();
            }
        }
        foreach($applicant->work_experiences as $work) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (!isset($oldWorkExperiences[$work->id]) || $oldWorkExperiences[$work->id] === null) {
                $work->delete();
            }
        }

        //Save new entities
        foreach($newDegrees as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }
        foreach($newCourses as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }
        foreach($newWorkExperiences as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }

        //Save old entities
        foreach($oldDegrees as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }
        foreach($oldCourses as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }
        foreach($oldWorkExperiences as $entity) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $entity->save();
        }

        return redirect( route('profile.experience.edit', $applicant) );

The expression return redirect(route('profile.experience.edit', $applicant)) returns the type Illuminate\Http\RedirectResponse which is incompatible with the documented return type Illuminate\Http\Response.

        //Debugbar::info($oldDegrees);
        // return view('applicant/profile_02_experience', [
        //     'applicant' => $applicant,
        //     'profile' => Lang::get('applicant/profile_experience'),
        //     'degree_types' => DegreeType::all(),
        //     'course_status' => CourseStatus::all(),
        //     'degree_template' => Lang::get('common/degree'),
        //     'course_template' => Lang::get('common/course'),
        //     'work_template' => Lang::get('common/work_experience'),
        //     'form_submit_action' => route('profile.experience.update', $applicant),
        // ]);
    }

}