App\Services\Validation\ApplicationValidator

Complexity

Total Complexity

18

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	arrayMapKeys()	0	6	2
A	__construct()	0	4	1
A	validate()	0	17	1
A	assetSkillsComplete()	0	2	1
A	basicsValidator()	0	27	3
A	skillsValidator()	0	22	3
A	essentialSkillsComplete()	0	2	1
A	basicsComplete()	0	3	1
A	essentialSkillsValidator()	0	2	1
A	affirmationValidator()	0	14	1
A	affirmationComplete()	0	2	1
A	addNestedValidatorRules()	0	9	1
A	assetSkillsValidator()	0	2	1

<?php

Missing file doc comment

namespace App\Services\Validation;

use App\Models\JobApplication;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Validator as BaseValidator;
use App\Models\Lookup\CitizenshipDeclaration;
use App\Models\Lookup\CriteriaType;
use App\Models\Lookup\VeteranStatus;
use App\Models\Lookup\PreferredLanguage;
use App\Services\Validation\Rules\ContainsObjectWithAttributeRule;
use App\Services\Validation\JobApplicationAnswerValidator;

class ApplicationValidator {

Missing doc comment for class ApplicationValidator

Opening brace of a class must be on the line after the definition

    protected $citizenship_ids;
    protected $veteran_status_ids;
    protected $preferred_language_ids;

    public function __construct() {

Missing doc comment for function __construct()

        $this->citizenship_ids = CitizenshipDeclaration::all()->pluck('id')->toArray();
        $this->veteran_status_ids = VeteranStatus::all()->pluck('id')->toArray();
        $this->preferred_language_ids = PreferredLanguage::all()->pluck('id')->toArray();
    }

    public function validate(JobApplication $application) {

Missing doc comment for function validate()

        $rules = [

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

        ];

        //Validate basic data is filled in
        Validator::make($application->getAttributes(), [

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

            'job_poster_id' => 'required',
            'application_status_id' => 'required',
            'citizenship_declaration_id' => ['required', Rule::in($this->citizenship_ids)],
            'veteran_status_id' => ['required', Rule::in($this->veteran_status_ids)],
            'preferred_language_id' => ['required', Rule::in($this->preferred_language_ids)],
            'applicant_id' => 'required',
            'submission_signature' => 'required|string|max:191',
            'submission_date' => 'required|string|max:191',
        ])->validate();

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

        //TODO
        //Validate that all questions have been answered

        //TODO
        //Validate that essential skill declarations have been supplied
    }

    protected function arrayMapKeys($fn, $array) {

Missing doc comment for function arrayMapKeys()

        $newArray = [];
        foreach($array as $key => $value) {

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

            $newArray[$fn($key)] = $value;
        }
        return $newArray;
    }

    protected function addNestedValidatorRules($nestedAttribute, $validatorRules, $rules = []) {

Missing doc comment for function addNestedValidatorRules()

        // prepend the attribute name of each validator rule with the nested attribute name
        $newRules = $this->arrayMapKeys(function($key) use ($nestedAttribute) {

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

                return implode('.', [$nestedAttribute, $key]);
            },

Closing brace indented incorrectly; expected 8 spaces, found 12

            $validatorRules);

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

        //Merge new rules with old rules
        $rules = array_merge($rules, $newRules);
        return $rules;
    }

    public function basicsValidator(JobApplication $application) {

Missing doc comment for function basicsValidator()

        // Validate the fields common to every application
        $rules = [
            'citizenship_declaration_id' => ['required', Rule::in($this->citizenship_ids)],
            'veteran_status_id' => ['required', Rule::in($this->veteran_status_ids)],
            'preferred_language_id' => ['required', Rule::in($this->preferred_language_ids)],
        ];

        //Load application answers so they are included in application->toArray()
        $application->load('job_application_answers');

        // Validate that each question has been answered
        $jobPosterQuestionRules = [];
        foreach($application->job_poster->job_poster_questions as $question) {

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

            $jobPosterQuestionRules[] = new ContainsObjectWithAttributeRule('job_poster_question_id', $question->id);
        }
        $rules['job_application_answers'] = $jobPosterQuestionRules;
        $answerValidatorFactory = new JobApplicationAnswerValidator($application);

        //Validate that each answer is complete
        foreach($application->job_application_answers as $key=>$answer) {

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

            $attribute = implode('.', ['job_application_answers', $key]);
            $rules = $this->addNestedValidatorRules($attribute, $answerValidatorFactory->rules(), $rules);
        }

        $validator = Validator::make($application->toArray(), $rules);
        return $validator;
    }

    public function basicsComplete(JobApplication $application) {

Missing doc comment for function basicsComplete()

        $validator = $this->basicsValidator($application);
        return $validator->passes();
    }

    protected function skillsValidator(JobApplication $application, $criteria_type) {

Missing doc comment for function skillsValidator()

        $rules = [];

        $skillDeclarationRules = [];
        $criteriaTypeId = CriteriaType::where('name', $criteria_type)->firstOrFail()->id;
        foreach($application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId) as $criteria) {

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

            //Validate that every essential skill has a corresponding declaration
            $skillDeclarationRules[] = new ContainsObjectWithAttributeRule('skill_id', $criteria->skill_id);
        }
        $rules['skill_declarations'] = $skillDeclarationRules;
        $application->applicant->load('skill_declarations');

        //Validate that those declarations are complete
        $skilDeclarationValidatorFactory = new SkillDeclarationValidator($application->applicant);
        foreach($application->skill_declarations->where('criteria_type_id', $criteriaTypeId) as $key=>$declaration) {

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

            $attribute = implode('.', ['skill_declarations', $key]);
            $skilDeclarationValidator = $skilDeclarationValidatorFactory->validator($declaration);
            $rules = $this->addNestedValidatorRules($attribute, $skilDeclarationValidator->getRules(), $rules);
        }

        $validator = Validator::make($application->toArray(), $rules);
        return $validator;
    }

    public function essentialSkillsValidator(JobApplication $application) {

Missing doc comment for function essentialSkillsValidator()

        return $this->skillsValidator($application, 'essential');
    }

    public function essentialSkillsComplete(JobApplication $application) {

Missing doc comment for function essentialSkillsComplete()

        return $this->essentialSkillsValidator($application)->passes();
    }

    public function assetSkillsValidator(JobApplication $application) {

Missing doc comment for function assetSkillsValidator()

        return $this->skillsValidator($application, 'asset');
    }

    public function assetSkillsComplete(JobApplication $application) {

Missing doc comment for function assetSkillsComplete()

        return $this->assetSkillsValidator($application)->passes();
    }

    public function affirmationValidator(JobApplication $application) {

Missing doc comment for function affirmationValidator()

        $rules = [
            'submission_signature' => [
                'required',
                'string',
                'max:191',
            ],
            'submission_date' => [
                'required',
                'string',
                'max:191',
           ]
        ];
        return Validator::make($application->toArray(), $rules);
    }

    public function affirmationComplete(JobApplication $application) {

Missing doc comment for function affirmationComplete()

        return $this->affirmationValidator($application)->passes();
    }
}