App\Http\Controllers\ReferencesController

Complexity

Total Complexity

9

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Test Coverage

Coverage

91.84%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	editAuthenticated()	0	4	1
A	edit()	0	7	1
A	destroy()	0	16	2
A	update()	0	51	5

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Lang;
use Illuminate\Support\Facades\Log;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use App\Models\Skill;
use App\Models\Applicant;
use App\Models\Reference;
use App\Models\Project;
use App\Models\Lookup\Relationship;
use App\Services\Validation\Requests\UpdateReferenceValidator;

class ReferencesController extends Controller
{

    /**
     * Show the form for editing the logged-in applicant's references
     *
     * @param  Request $request

Missing parameter comment

     * @return \Illuminate\Http\RedirectResponse
     */
    public function editAuthenticated(Request $request): \Illuminate\Http\RedirectResponse
    {
        $applicant = $request->user()->applicant;
        return redirect(route('profile.references.edit', $applicant));
    }

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

Missing parameter comment

     * @param  \App\Models\Applicant $applicant

Missing parameter comment

     * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory
     */
    public function edit(Request $request, Applicant $applicant)
    {
        return view('applicant/profile_04_references', [
            'applicant' => $applicant,
            'profile' => Lang::get('applicant/profile_references'),
            'reference_template' => Lang::get('common/references'),
            'relationships' => Relationship::all(),
        ]);
    }

    /**
     * Update or create a reference with the supplied data.
     *
     * @param \Illuminate\Http\Request   $request   The incoming request object.
     * @param \App\Models\Reference|null $reference The reference to update. If null, a new one should be created.
     *
     * @return

Return type missing for @return tag in function comment

     */
    public function update(Request $request, ?Reference $reference = null)

Method \App\Http\Controllers\ReferencesController::update() does not have return type hint nor @return annotation for its return value.

    {
        $validator = new UpdateReferenceValidator();
        $validator->validate($request->input());

        if ($reference === null) {
            $reference = new Reference();
            $reference->applicant_id = $request->user()->applicant->id;
        }
        $reference->fill([
            'name' => $request->input('name'),
            'email' => $request->input('email'),
            'relationship_id' => $request->input('relationship_id'),
            'description' => $request->input('description'),
        ]);
        $reference->save();

        $reference->load('projects');

        //TODO: As soon as you can interact with projects outside of references,
        //  this will become a dangerous operation
        $reference->projects()->delete();

        $newProjects = [];
        if ($request->input('projects')) {
            foreach ($request->input('projects') as $projectInput) {
                $project = new Project();
                $project->applicant_id = $reference->applicant_id;
                $project->fill([
                    'name' => $projectInput['name'],
                    'start_date' => $projectInput['start_date'],
                    'end_date' => $projectInput['end_date'],
                ]);
                $project->save();
                $newProjects[] = $project->id;
                // $reference->projects()->attach($project);
            }
        }
        $reference->projects()->sync($newProjects);

        //Attach relatives
        $skillIds = $this->getRelativeIds($request->input(), 'skills');
        $reference->skill_declarations()->sync($skillIds);

        // if an ajax request, return the new object
        if ($request->ajax()) {
            $reference->load('relationship');
            $reference->load('projects');
            return $reference->toJson();
        } else {
            return redirect()->back();
        }
    }

    /**
     * Delete the particular reference from storage.
     *
     * @param  \Illuminate\Http\Request $request

Missing parameter comment

     * @param  \App\Models\Reference    $reference

Missing parameter comment

     * @return \Illuminate\Http\Response
     */
    public function destroy(Request $request, Reference $reference)

Method \App\Http\Controllers\ReferencesController::destroy() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Http\Response".

    {
        $this->authorize('delete', $reference);

        //TODO: when projects exist independently on profile, delete seperatley
        $reference->projects()->delete();

        $reference->delete();

        if ($request->ajax()) {
            return [

The expression return array('message' => 'Reference deleted') returns the type array<string,string> which is incompatible with the documented return type Illuminate\Http\Response.

                "message" => 'Reference deleted'
            ];
        }

        return redirect()->back();

The expression return redirect()->back() returns the type Illuminate\Http\RedirectResponse which is incompatible with the documented return type Illuminate\Http\Response.

    }
}