App\Services\Validation\ApplicationValidator

Complexity

Total Complexity

24

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	assetSkillsComplete()	0	3	1
A	validator()	0	29	1
A	arrayMapKeys()	0	7	2
B	skillsValidator()	0	32	6
A	essentialSkillsComplete()	0	3	1
A	essentialSkillsValidator()	0	3	1
A	experienceComplete()	0	3	1
A	affirmationValidator()	0	3	1
A	validateComplete()	0	3	1
A	validate()	0	3	1
A	affirmationComplete()	0	3	1
A	addNestedValidatorRules()	0	12	1
A	assetSkillsValidator()	0	3	1
A	basicsValidator()	0	6	1
A	experienceValidator()	0	3	1
A	basicsComplete()	0	4	1
A	basicRules()	0	26	2

<?php

namespace App\Services\Validation;

use App\Models\JobApplication;
use Illuminate\Support\Facades\Validator;
use App\Models\Lookup\CriteriaType;
use App\Services\Validation\Rules\ContainsObjectWithAttributeRule;
use App\Services\Validation\JobApplicationAnswerValidator;

class ApplicationValidator
{

    public function validator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::validator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function validator()

    {
        $backendRules = [
            'job_poster_id' => 'required',
            'application_status_id' => 'required',
            'applicant_id' => 'required',
        ];
        $data = $application->toArray();

        $rules = array_merge(
            $backendRules,
            $this->experienceRules,
            $this->affirmationRules
        );

        // Combining and simplifiying error messages
        $rules = array_merge(
            $rules,
            ['application_step_1' => 'required|boolean|accepted'],
            ['application_step_3' => 'required|boolean|accepted']
        );
        $data = array_merge(
            $data,
            ['application_step_1' => $this->basicsComplete($application)],
            ['application_step_3' => $this->essentialSkillsComplete($application)]
        );

        // Validate basic data is filled in
        return Validator::make($data, $rules);
    }

    public function validate(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::validate() does not have void return type hint.

Missing doc comment for function validate()

    {
        $this->validator($application)->validate();
    }

    public function validateComplete(JobApplication $application): bool

Missing doc comment for function validateComplete()

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

    /**
     * Return a copy of $array, with function $fn applied to each key, but values left unchanged.
     *
     * @param function $fn    Function applied to each key.
     * @param array    $array Array to operate on.

@param annotation of method \App\Services\Validation\ApplicationValidator::arrayMapKeys() does not specify type hint for items of its traversable parameter $array.

     * @return array

@return annotation of method \App\Services\Validation\ApplicationValidator::arrayMapKeys() does not specify type hint for items of its traversable return value.

     */
    protected function arrayMapKeys($fn, $array): array

Method \App\Services\Validation\ApplicationValidator::arrayMapKeys() does not have native type hint for its parameter $fn but it should be possible to add it based on @param annotation "function".

Method \App\Services\Validation\ApplicationValidator::arrayMapKeys() does not have native type hint for its parameter $array but it should be possible to add it based on @param annotation "array".

Type hint "function" missing for $fn

Type hint "array" missing for $array

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

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

Method \App\Services\Validation\ApplicationValidator::addNestedValidatorRules() does not have parameter type hint nor @param annotation for its parameter $nestedAttribute.

Method \App\Services\Validation\ApplicationValidator::addNestedValidatorRules() does not have parameter type hint nor @param annotation for its parameter $validatorRules.

Method \App\Services\Validation\ApplicationValidator::addNestedValidatorRules() does not have parameter type hint nor @param annotation for its parameter $rules.

Method \App\Services\Validation\ApplicationValidator::addNestedValidatorRules() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function addNestedValidatorRules()

    {
        // prepend the attribute name of each validator rule with the nested attribute name

Inline comments must start with a capital letter

        $newRules = $this->arrayMapKeys(
            function ($key) use ($nestedAttribute) {

function(...) { /* ... */ } of type callable is incompatible with the type App\Services\Validation\function expected by parameter $fn of App\Services\Validation\ApplicationValidator::arrayMapKeys().

                return implode('.', [$nestedAttribute, $key]);
            },
            $validatorRules
        );
        // Merge new rules with old rules
        $rules = array_merge($rules, $newRules);
        return $rules;
    }

    public function basicRules(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::basicRules() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function basicRules()

    {
        // Validate the fields common to every application
        $rules = [
            'language_requirement_confirmed' => ['required', 'boolean'],
            'citizenship_declaration_id' => ['required', 'exists:citizenship_declarations,id'],
            'veteran_status_id' => ['required', 'exists:veteran_statuses,id'],
            'preferred_language_id' => ['required', 'exists:preferred_languages,id'],
        ];

        // Merge with Answer rules, that ensure each answer is complete
        $answerValidator = new JobApplicationAnswerValidator($application);
        $rules = $this->addNestedValidatorRules(
            'job_application_answers.*',
            $answerValidator->rules(),
            $rules
        );

        // Validate that each question has been answered
        $jobPosterQuestionRules = [];
        foreach ($application->job_poster->job_poster_questions as $question) {
            $jobPosterQuestionRules[] = new ContainsObjectWithAttributeRule('job_poster_question_id', $question->id);
        }
        $rules['job_application_answers'] = $jobPosterQuestionRules;

        return $rules;
    }
    public function basicsValidator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::basicsValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function basicsValidator()

    {
        // Load application answers so they are included in application->toArray().
        $application->load('job_application_answers');
        $validator = Validator::make($application->toArray(), $this->basicRules($application));
        return $validator;
    }

    public function basicsComplete(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::basicsComplete() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function basicsComplete()

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

    public $experienceRules = ['experience_saved' => 'required|boolean|accepted'];

Missing member variable doc comment

    public function experienceValidator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::experienceValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function experienceValidator()

    {
        return Validator::make($application->attributesToArray(), $this->experienceRules);
    }

    public function experienceComplete(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::experienceComplete() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function experienceComplete()

    {
        return $this->experienceValidator($application)->passes();
    }

    protected function skillsValidator(JobApplication $application, $criteria_type)

Method \App\Services\Validation\ApplicationValidator::skillsValidator() does not have parameter type hint nor @param annotation for its parameter $criteria_type.

Method \App\Services\Validation\ApplicationValidator::skillsValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function skillsValidator()

    {
        $rules = [];

        // If application is still a draft, check skills attached to applicant profile. If submitted, use application itself.
        $skillDeclarationsAttribute = $application->isDraft() ? 'applicant.skill_declarations' : 'skill_declarations';
        $application->load($skillDeclarationsAttribute);
        $skillDeclarations = $application->isDraft()
            ? $application->applicant->skill_declarations
            : $application->skill_declarations;

        $skillDeclarationRules = [];
        $criteriaTypeId = CriteriaType::where('name', $criteria_type)->firstOrFail()->id;
        foreach ($application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId) as $criteria) {
            // Validate that every essential skill has a corresponding declaration
            $skillDeclarationRules[] = new ContainsObjectWithAttributeRule('skill_id', $criteria->skill_id);
        }
        $rules[$skillDeclarationsAttribute] = $skillDeclarationRules;

        // Validate that those declarations are complete
        $skillDeclarationValidatorFactory = new SkillDeclarationValidator();
        $relevantSkillIds = $application->job_poster->criteria->where('criteria_type_id', $criteriaTypeId)->pluck('skill_id');
        foreach ($skillDeclarations as $key => $declaration) {
            if ($relevantSkillIds->contains($declaration->skill_id)) {
                $attribute = implode('.', [$skillDeclarationsAttribute, $key]);
                $skillDeclarationValidator = $skillDeclarationValidatorFactory->validator($declaration);
                $rules = $this->addNestedValidatorRules($attribute, $skillDeclarationValidator->getRules(), $rules);
            }
        }

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

    public function essentialSkillsValidator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::essentialSkillsValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function essentialSkillsValidator()

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

    public function essentialSkillsComplete(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::essentialSkillsComplete() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function essentialSkillsComplete()

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

    public function assetSkillsValidator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::assetSkillsValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function assetSkillsValidator()

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

    public function assetSkillsComplete(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::assetSkillsComplete() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function assetSkillsComplete()

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

    public $affirmationRules = [

Missing member variable doc comment

        'submission_signature' => [
            'required',
            'string',
            'max:191',
        ],
        'submission_date' => [
            'required',
            'string',
            'max:191',
        ]
    ];
    public function affirmationValidator(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::affirmationValidator() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function affirmationValidator()

    {
        return Validator::make($application->toArray(), $this->affirmationRules);
    }

    public function affirmationComplete(JobApplication $application)

Method \App\Services\Validation\ApplicationValidator::affirmationComplete() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function affirmationComplete()

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