App\Http\Controllers\Api\JobApiController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

78.26%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	jobToArray()	0	10	2
A	store()	0	2	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\Http\Request;
use App\Http\Controllers\Controller;
use App\Models\JobPoster;
use App\Models\Criteria;
use App\Services\Validation\JobPosterValidator;
use App\Http\Requests\UpdateJobPoster;

class JobApiController extends Controller
{
    public function __construct()

Missing doc comment for 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 JobPoster $job

Missing parameter comment

     * @return mixed[]
     */
    private function jobToArray(JobPoster $job)

Method \App\Http\Controllers\Api\JobApiController::jobToArray() does not have return type hint for its return value but it should be possible to add it based on @return annotation "mixed[]".

    {
        $criteria = Criteria::where('job_poster_id', $job->id)->get();
        $criteriaTranslated = [];
        foreach ($criteria as $criterion) {
            // TODO: getTranslationsArray probably makes DB calls every loop. Find a way to profile & optimize.
            $criteriaTranslated[] = array_merge($criterion->toArray(), $criterion->getTranslationsArray());
        }
        $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  \Illuminate\Http\Request  $request

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Http\Response

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

     */
    public function store(Request $request)

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

    {
        //TODO: complete
    }

    /**
     * Display the specified resource.
     *
     * @param JobPoster $job

Missing parameter comment

     * @return \Illuminate\Http\Response
     */
    public function show(JobPoster $job)

Method \App\Http\Controllers\Api\JobApiController::show() 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".

    {
        return $this->jobToArray($job);

The expression return $this->jobToArray($job) returns the type array<mixed,mixed> which is incompatible with the documented return type Illuminate\Http\Response.

    }

    /**

Doc comment for parameter "$job" missing

     * Update the specified resource in storage.
     *
     * @param  App\Http\Requests\UpdateJobPoster  $request Validates input.

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

Expected 1 spaces after parameter type; 2 found

Expected 2 spaces after parameter name; 1 found

     * @param  JobPoster $jobPoser

Missing parameter comment

Expected 25 spaces after parameter type; 1 found

Doc comment for parameter $jobPoser does not match actual variable name $job

     * @return \Illuminate\Http\Response
     */
    public function update(UpdateJobPoster $request, JobPoster $job)

Method \App\Http\Controllers\Api\JobApiController::update() 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".

    {
        $request->validated();
        JobPosterValidator::validateUnpublished($job);
        // Only values in the JobPoster->fillable array will be set
        $job->fill($request->input());
        $job->save();
        return $this->jobToArray($job);

The expression return $this->jobToArray($job) returns the type array<mixed,mixed> which is incompatible with the documented return type Illuminate\Http\Response.

    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  int  $id

Missing parameter comment

Expected "integer" but found "int" for parameter type

Expected 1 spaces after parameter type; 2 found

     * @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.

Method \App\Http\Controllers\Api\JobApiController::destroy() does not have parameter type hint for its parameter $id but it should be possible to add it based on @param annotation "int".

Type hint "int" missing for $id

    {
        // TODO:
    }
}