App\Http\Controllers\Api\JobApiController

Complexity

Total Complexity

9

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Test Coverage

Coverage

85.71%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	jobToArray()	0	11	1
A	submitForReview()	0	15	2
A	store()	0	8	1
A	destroy()	0	2	1
A	update()	0	8	1
A	__construct()	0	4	1
A	index()	0	2	1
A	show()	0	3	1

<?php

namespace App\Http\Controllers\Api;

use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Facades\Auth;
use App\Mail\JobPosterReviewRequested;
use App\Http\Controllers\Controller;
use App\Models\JobPoster;
use App\Models\Criteria;
use Jenssegers\Date\Date;
use App\Http\Requests\UpdateJobPoster;
use App\Http\Requests\StoreJobPoster;

class JobApiController extends Controller
{
    /**
     * Class constructor
     */
    public function __construct()
    {
        // This applies the appropriate policy to each resource route.
        $this->authorizeResource(JobPoster::class, 'job');
    }

    /**
     * Convert a job poster to the array expected by API requests,
     * with all criteria,
     * and with translation arrays in both languages.
    *
     * @param  \App\Models\JobPoster $job Incoming Job Poster object.
     * @return mixed[]
     */
    private function jobToArray(JobPoster $job)
    {
        $criteria = Criteria::where('job_poster_id', $job->id)->get();

        $toApiArray = function ($model) {
            return array_merge($model->toArray(), $model->getTranslationsArray());
        };
        $criteriaTranslated = $criteria->map($toApiArray);

        $jobArray = array_merge($job->toApiArray(), ['criteria' => $criteriaTranslated]);
        return $jobArray;
    }
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response

Function return type is not void, but function has no return statement

     */
    public function index()
    {
        // TODO: complete.
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \App\Http\Requests\StoreJobPoster $request Incoming request.
     * @return \Illuminate\Http\Response
     */
    public function store(StoreJobPoster $request)
    {
        $data = $request->validated();
        $job = new JobPoster();
        $job->manager_id = $request->user()->manager->id;
        $job->fill($data);
        $job->save();
        return response()->json($this->jobToArray($job));
    }

    /**
     * Display the specified resource.
     *
     * @param  \App\Models\JobPoster $job Incoming Job Poster.
     * @return \Illuminate\Http\Response
     */
    public function show(JobPoster $job)
    {
        return response()->json($this->jobToArray($job));
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  \App\Http\Requests\UpdateJobPoster $request Validates input.
     * @param  \App\Models\JobPoster              $job     Incoming Job Poster.
     * @return \Illuminate\Http\Response
     */
    public function update(UpdateJobPoster $request, JobPoster $job)
    {
        $data = $request->validated();
        // Only values both in the JobPoster->fillable array,
        // and returned by UpdateJobPoster->validatedData(), will be set.
        $job->fill($data);
        $job->save();
        return response()->json($this->jobToArray($job->fresh()));
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  integer $id Job Poster ID.
     * @return \Illuminate\Http\Response

Function return type is not void, but function has no return statement

     */
    public function destroy($id)

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

Type hint "int" missing for $id

    {
        // TODO: complete.
    }

    /**
     * Submit the Job Poster for review.
     *
     * @param  \App\Models\JobPoster    $job Job Poster object.

Expected 1 spaces after parameter type; 4 found

     * @return \Illuminate\Http\Response
     */
    public function submitForReview(JobPoster $job)
    {
        // Update review request timestamp.
        $job->review_requested_at = new Date();
        $job->save();

        // Send email.
        $reviewer_email = config('mail.reviewer_email');
        if (isset($reviewer_email)) {
            Mail::to($reviewer_email)->send(new JobPosterReviewRequested($job, Auth::user()));

It seems like Illuminate\Support\Facades\Auth::user() can also be of type null; however, parameter $manager of App\Mail\JobPosterReviewRequested::__construct() does only seem to accept App\Models\User, maybe add an additional type check?

        } else {
            Log::error('The reviewer email environment variable is not set.');

The type App\Http\Controllers\Api\Log was not found. Did you mean Log? If so, make sure to prefix the type with \.

        }

        return response()->json($this->jobToArray($job));
    }
}