App\Models\JobApplication

Complexity

Total Complexity

32

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Test Coverage

Coverage

26.76%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	preferred_language()	0	2	1
A	meetsEssentialCriteria()	0	15	4
A	applicant_snapshot()	0	2	1
A	job_poster()	0	2	1
A	application_review()	0	2	1
A	citizenship_declaration()	0	2	1
A	veteran_status()	0	2	1
C	getSectionStatus()	0	43	16
A	application_status()	0	2	1
A	getMeetsEssentialCriteriaAttribute()	0	3	1
A	applicant()	0	2	1
A	createApplicantSnapshot()	0	4	1
A	skill_declarations()	0	3	1
A	job_application_answers()	0	2	1

<?php

/**
 * Created by Reliese Model.
 * Date: Thu, 12 Jul 2018 22:39:27 +0000.
 */

namespace App\Models;
use App\Models\Lookup\VeteranStatus;
use App\Models\Lookup\PreferredLanguage;
use App\Models\Lookup\CitizenshipDeclaration;
use App\Models\Applicant;
use App\Models\SkillDeclaration;
use App\Models\ApplicationReview;
use Illuminate\Notifications\Notifiable;
use App\Events\ApplicationSaved;
use App\Events\ApplicationRetrieved;
use App\Services\Validation\ApplicationValidator;

/**
 * Class JobApplication
 *
 * @property int $id
 * @property int $job_poster_id
 * @property int $application_status_id
 * @property int $citizenship_declaration_id
 * @property int $veteran_status_id
 * @property int $preferred_language_id
 * @property int $applicant_id
 * @property int $applicant_snapshot_id
 * @property string $submission_signature
 * @property string $submission_date
 * @property boolean $experience_saved
 * @property boolean $language_requirement_confirmed
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * @property \App\Models\Applicant $applicant
 * @property \App\Models\Applicant $applicant_snapshot
 * @property \App\Models\Lookup\ApplicationStatus $application_status
 * @property \App\Models\Lookup\CitizenshipDeclaration $citizenship_declaration
 * @property \App\Models\Lookup\VeteranStatus $veteran_status
 * @property \App\Models\Lookup\PreferredLanguage $preferred_language
 * @property \App\Models\JobPoster $job_poster
 * @property \Illuminate\Database\Eloquent\Collection $job_application_answers
 * @property \Illuminate\Database\Eloquent\Collection $skill_declarations
 * @property \App\Models\ApplicationReview $application_review
 */
class JobApplication extends BaseModel {

    use Notifiable;

The trait Illuminate\Notifications\Notifiable requires some properties which are not provided by App\Models\JobApplication: $email, $phone_number

    protected $dispatchesEvents = [

Property \App\Models\JobApplication::$dispatchesEvents does not have @var annotation.

Missing member variable doc comment

        'retrieved' => ApplicationRetrieved::class,
        'saved' => ApplicationSaved::class,
    ];

    protected $casts = [

Property \App\Models\JobApplication::$casts does not have @var annotation.

Missing member variable doc comment

        'job_poster_id' => 'int',
        'application_status_id' => 'int',
        'citizenship_declaration_id' => 'int',
        'veteran_status_id' => 'int',
        'preferred_language_id' => 'int',
        'applicant_id' => 'int',
        'applicant_snapshot_id' => 'int',
        'submission_signature' => 'string',
        'submission_date' => 'string',
        'experience_saved' => 'boolean',
        'language_requirement_confirmed' => 'boolean'
    ];
    protected $fillable = [

Property \App\Models\JobApplication::$fillable does not have @var annotation.

Missing member variable doc comment

        'citizenship_declaration_id',
        'language_requirement_confirmed',
        'veteran_status_id',
        'preferred_language_id',
        'submission_signature',
        'submission_date',
        'experience_saved',
    ];

    /**
     * The accessors to append to the model's array/json form.
     *
     * @var array

@var annotation of property \App\Models\JobApplication::$appends does not specify type hint for its items.

     */
    protected $appends = ['meets_essential_criteria'];

    protected function createApplicantSnapshot($applicant_id) {

Method \App\Models\JobApplication::createApplicantSnapshot() does not have parameter type hint nor @param annotation for its parameter $applicant_id.

Method \App\Models\JobApplication::createApplicantSnapshot() does not have void return type hint.

Missing doc comment for function createApplicantSnapshot()

        $applicant = Applicant::where('id', $applicant_id)->firstOrFail();

        $snapshot = $applicant->replicate();

The assignment to $snapshot is dead and can be removed.

    }

Function closing brace must go on the next line following the body; found 1 blank lines before brace

    public function applicant() {

Method \App\Models\JobApplication::applicant() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function applicant()

        return $this->belongsTo(\App\Models\Applicant::class);
    }

    public function applicant_snapshot() {

Method name "JobApplication::applicant_snapshot" is not in camel caps format

Method \App\Models\JobApplication::applicant_snapshot() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function applicant_snapshot()

        return $this->belongsTo(\App\Models\Applicant::class, 'applicant_snapshot_id');
    }

    public function application_status() {

Method name "JobApplication::application_status" is not in camel caps format

Method \App\Models\JobApplication::application_status() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function application_status()

        return $this->belongsTo(\App\Models\Lookup\ApplicationStatus::class);
    }

    public function citizenship_declaration() {

Method name "JobApplication::citizenship_declaration" is not in camel caps format

Method \App\Models\JobApplication::citizenship_declaration() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function citizenship_declaration()

        return $this->belongsTo(\App\Models\Lookup\CitizenshipDeclaration::class);
    }

    public function veteran_status() {

Method name "JobApplication::veteran_status" is not in camel caps format

Method \App\Models\JobApplication::veteran_status() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function veteran_status()

        return $this->belongsTo(\App\Models\Lookup\VeteranStatus::class);
    }

    public function preferred_language() {

Method name "JobApplication::preferred_language" is not in camel caps format

Method \App\Models\JobApplication::preferred_language() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function preferred_language()

        return $this->belongsTo(\App\Models\Lookup\PreferredLanguage::class);
    }

    public function job_poster() {

Method name "JobApplication::job_poster" is not in camel caps format

Method \App\Models\JobApplication::job_poster() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function job_poster()

        return $this->belongsTo(\App\Models\JobPoster::class);
    }

    public function job_application_answers() {

Method name "JobApplication::job_application_answers" is not in camel caps format

Method \App\Models\JobApplication::job_application_answers() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function job_application_answers()

        return $this->hasMany(\App\Models\JobApplicationAnswer::class);
    }

    public function skill_declarations() {

Method name "JobApplication::skill_declarations" is not in camel caps format

Method \App\Models\JobApplication::skill_declarations() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function skill_declarations()

        return $this->applicant->skill_declarations()
            ->whereIn('skill_id', $this->job_poster->criteria->pluck('skill_id'));
    }

    public function application_review() {

Method name "JobApplication::application_review" is not in camel caps format

Method \App\Models\JobApplication::application_review() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function application_review()

        return $this->hasOne(ApplicationReview::class);
    }

    /**
     * Return either 'complete', 'incomplete' or 'error', depending on the
     * status of the requested section.
     *
     * @param  string $section Should be one of:

Parameter comment must end with a full stop

     *                              'basics'
     *                              'experience'
     *                              'essential_skills'
     *                              'asset_skills'
     *                              'preview'
     *
     * @return string $status   'complete', 'incomplete' or 'error'
     */
    public function getSectionStatus(string $section) {

Method \App\Models\JobApplication::getSectionStatus() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string".

        //TODO: determine whether sections are complete or invalid
        $validator = new ApplicationValidator();
        $status = 'incomplete';
        switch($section) {

Expected 1 space(s) after SWITCH keyword; 0 found

            case 'basics':
                if ($validator->basicsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'experience':
                if ($validator->experienceComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'essential_skills':
                if ($validator->essentialSkillsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'asset_skills':
                if ($validator->assetSkillsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'preview':
                if ($validator->basicsComplete($this) &&
                    $validator->experienceComplete($this) &&
                    $validator->essentialSkillsComplete($this) &&
                    $validator->assetSkillsComplete($this)) {
                    $status = 'complete';
                }
                break;
            case 'confirm':
                if ($validator->affirmationComplete($this)) {
                    $status = 'complete';
                }
                break;
            default:
                $status = 'error';
                break;
        }
        return $status;
    }

    /**
     * Returns true if this application meets all the essential criteria.
     * That means it has attached an SkillDeclaration for each essential criterion,
     * with a level at least as high as the required level.
     *
     * @return boolean
     */
    public function meetsEssentialCriteria(): bool
    {
        $essentialCriteria = $this->job_poster->criteria->filter(
            function ($value, $key) {

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

                return $value->criteria_type->name == 'essential';
            }
        );
        foreach ($essentialCriteria as $criterion) {
            $skillDeclaration = $this->skill_declarations->where("skill_id", $criterion->skill_id)->first();
            if ($skillDeclaration === null ||
                $skillDeclaration->skill_level_id < $criterion->skill_level_id) {
                return false;
            }
        }
        return true;
    }

    /**
     * Accessor for meetsEssentialCriteria function, which
     * allows this value to be automtacially appended to array/json representation.
     *
     * @return boolean
     */
    public function getMeetsEssentialCriteriaAttribute():bool
    {
        return $this->meetsEssentialCriteria();
    }
}