JobPoster::setClassificationCodeAttribute() - Code Metrics - Inspection of "Redux hrAdvisor store partly done" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/redux-claim-job ( b0411b )

by Tristan

created 2019-12-05 23:04 UTC

JobPoster::setClassificationCodeAttribute() A

↳ Parent: JobPoster

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	7
rs	10
cc	2
nc	2
nop	1

<?php

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

namespace App\Models;

use Astrotomic\Translatable\Translatable;

use Backpack\CRUD\app\Models\Traits\CrudTrait;

use Jenssegers\Date\Date;

use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Lang;

use App\Events\JobSaved;

/**
 * Class JobPoster
 *
 * @property int $id
 * @property int $job_term_id
 * @property string $chosen_lang
 * @property int $term_qty
 * @property \Jenssegers\Date\Date $open_date_time
 * @property \Jenssegers\Date\Date $close_date_time
 * @property \Jenssegers\Date\Date $start_date_time
 * @property \Jenssegers\Date\Date $review_requested_at
 * @property \Jenssegers\Date\Date $published_at
 * @property int $department_id
 * @property int $province_id
 * @property int $salary_min
 * @property int $salary_max
 * @property int $noc
 * @property int $classification_id
 * @property int $classification_level
 * @property int $security_clearance_id
 * @property int $language_requirement_id
 * @property boolean $remote_work_allowed
 * @property int $manager_id
 * @property boolean $published
 * @property int $team_size
 * @property array $work_env_features This should be an array of boolean flags for features, ie json of shape {[feature: string]: boolean}
 * @property int $fast_vs_steady
 * @property int $horizontal_vs_vertical
 * @property int $experimental_vs_ongoing
 * @property int $citizen_facing_vs_back_office
 * @property int $collaborative_vs_independent
 * @property int $telework_allowed_frequency_id
 * @property int $flexible_hours_frequency_id
 * @property int $travel_requirement_id
 * @property int $overtime_requirement_id
 * @property int $process_number
 * @property int $priority_clearance_number
 * @property \Jenssegers\Date\Date $loo_issuance_date
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * @property int $submitted_applications_count
 *
 * @property \App\Models\Lookup\Department $department
 * @property \App\Models\Lookup\JobTerm $job_term
 * @property \App\Models\Lookup\LanguageRequirement $language_requirement
 * @property \App\Models\Manager $manager
 * @property \App\Models\Lookup\Province $province
 * @property \App\Models\Lookup\SecurityClearance $security_clearance
 * @property \Illuminate\Database\Eloquent\Collection $criteria
 * @property \Illuminate\Database\Eloquent\Collection $job_applications
 * @property \Illuminate\Database\Eloquent\Collection $job_poster_key_tasks
 * @property \Illuminate\Database\Eloquent\Collection $job_poster_questions
 * @property \Illuminate\Database\Eloquent\Collection $job_poster_translations
 * @property \Illuminate\Database\Eloquent\Collection $submitted_applications
 * @property \Illuminate\Database\Eloquent\Collection $hr_advisors
 * @property \App\Models\Lookup\Frequency $telework_allowed_frequency
 * @property \App\Models\Lookup\Frequency $flexible_hours_frequency
 *
 * Localized Properties:
 * @property string $city
 * @property string $title
 * @property string $dept_impact
 * @property string $team_impact
 * @property string $hire_impact
 * @property string $division
 * @property string $education
 * @property string $work_env_description
 * @property string $culture_summary
 * @property string $culture_special
 *
 * Computed Properties
 * @property string $classification
 * @property string $classification_code
 *
 * Methods
 * @method boolean isOpen()
 * @method string timeRemaining()
 * @method mixed[] toApiArray()
 */
class JobPoster extends BaseModel
{
    use CrudTrait;

    use Translatable;

    use Notifiable;


    const DATE_FORMAT = [
        'en' => 'M jS, Y',
        'fr' => 'd M Y',
    ];
    const TIME_FORMAT = [
        'en' => 'h:i A T',
        'fr' => 'H \h i T',
    ];
    const TIMEZONE = 'America/Toronto';

    /**
     * @var string[] $translatedAttributes
     */
    public $translatedAttributes = [
        'city',
        'title',
        'dept_impact',
        'team_impact',
        'hire_impact',
        'division',
        'education',
        'work_env_description',
        'culture_summary',
        'culture_special',
    ];

    /**
     * @var string[] $casts
     */
    protected $casts = [
        'job_term_id' => 'int',
        'department_id' => 'int',
        'province_id' => 'int',
        'salary_min' => 'int',
        'salary_max' => 'int',
        'noc' => 'int',
        'classification_id' => 'int',
        'classification_level' => 'int',
        'security_clearance_id' => 'int',
        'language_requirement_id' => 'int',
        'remote_work_allowed' => 'boolean',
        'manager_id' => 'int',
        'published' => 'boolean',
        'team_size' => 'int',
        'work_env_features' => 'array',
        'fast_vs_steady' => 'int',
        'horizontal_vs_vertical' => 'int',
        'experimental_vs_ongoing' => 'int',
        'citizen_facing_vs_back_office' => 'int',
        'collaborative_vs_independent' => 'int',
        'telework_allowed_frequency_id' => 'int',
        'flexible_hours_frequency_id' => 'int',
        'travel_requirement_id' => 'int',
        'overtime_requirement_id' => 'int',
    ];

    /**
     * @var string[] $dates
     */
    protected $dates = [
        'open_date_time',
        'close_date_time',
        'start_date_time',
        'review_requested_at',
        'published_at',
        'loo_issuance_date',
    ];

    /**
     * @var string[] $fillable
     */
    protected $fillable = [
        'job_term_id',
        'chosen_lang',
        'term_qty',
        'open_date_time',
        'close_date_time',
        'start_date_time',
        'department_id',
        'province_id',
        'salary_min',
        'salary_max',
        'noc',
        'classification',
        'classification_code',
        'classification_level',
        'security_clearance_id',
        'language_requirement_id',
        'remote_work_allowed',
        'published',
        'team_size',
        'work_env_features',
        'fast_vs_steady',
        'horizontal_vs_vertical',
        'experimental_vs_ongoing',
        'citizen_facing_vs_back_office',
        'collaborative_vs_independent',
        'telework_allowed_frequency_id',
        'flexible_hours_frequency_id',
        'travel_requirement_id',
        'overtime_requirement_id',
        'process_number',
        'priority_clearance_number',
        'loo_issuance_date'
    ];

    /**
     * The attributes that should be visible in arrays.
     * In this case, it blocks loaded relations from appearing.
     *
     * @var array
     */
    protected $visible = [
        'id',
        'manager_id',
        'chosen_lang',
        'term_qty',
        'open_date_time',
        'close_date_time',
        'start_date_time',
        'department_id',
        'province_id',
        'salary_min',
        'salary_max',
        'noc',
        'classification_code',
        'classification_level',
        'security_clearance_id',
        'language_requirement_id',
        'remote_work_allowed',
        'published_at',
        'published',
        'review_requested_at',
        'team_size',
        'work_env_features',
        'fast_vs_steady',
        'horizontal_vs_vertical',
        'experimental_vs_ongoing',
        'citizen_facing_vs_back_office',
        'collaborative_vs_independent',
        'telework_allowed_frequency_id',
        'flexible_hours_frequency_id',
        'travel_requirement_id',
        'overtime_requirement_id',
        'process_number',
        'priority_clearance_number',
        'loo_issuance_date'
    ];

    /**
     * The accessors to append to the model's array form.
     *
     * @var mixed[] $appends
     */
    protected $appends = ['classification_code'];

    /**
     * @var mixed[] $dispatchesEvents
     */
    protected $dispatchesEvents = [
        'saved' => JobSaved::class,
    ];

    // @codeCoverageIgnoreStart
    public function department() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\Department::class);
    }

    public function job_term() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\JobTerm::class);
    }

    public function language_requirement() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\LanguageRequirement::class);
    }

    public function manager() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Manager::class);
    }

    public function province() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\Province::class);
    }

    public function security_clearance() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\SecurityClearance::class);
    }

    public function criteria() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\Criteria::class);
    }

    public function hr_advisors() // phpcs:ignore
    {
        return $this->belongsToMany(
            \App\Models\HrAdvisor::class,
            'claimed_jobs'
        );
    }

    public function job_applications() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobApplication::class);
    }

    public function job_poster_key_tasks() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobPosterKeyTask::class);
    }

    public function job_poster_questions() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobPosterQuestion::class);
    }

    public function job_poster_translations() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobPosterTranslation::class);
    }

    public function telework_allowed_frequency() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\Frequency::class);
    }

    public function flexible_hours_frequency() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\Frequency::class);
    }

    public function travel_requirement() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\TravelRequirement::class);
    }

    public function overtime_requirement() // phpcs:ignore
    {
        return $this->belongsTo(\App\Models\Lookup\OvertimeRequirement::class);
    }

    // Artificial Relations

    /**
     * Get all of the Job Applications submitted to this
     * Job Poster.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function submitted_applications() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobApplication::class)->whereDoesntHave('application_status', function ($query) : void {
            $query->where('name', 'draft');
        });
    }

    // Overrides

    /**
     * Retrieve the model for a bound value.
     * Seems to be a useful workaround for providing submitted_applications_count
     * to any bound routes that receive a jobPoster instance without using the
     * withCount property on the model itself.
     * See https://github.com/laravel/framework/issues/23957 for more info.
     *
     * @param mixed $value Value used to retrieve the model instance.
     *
     * @return \Illuminate\Database\Eloquent\Model|null
     */
    public function resolveRouteBinding($value) // phpcs:ignore
    {
        return $this->withCount('submitted_applications')->where('id', $value)->first() ?? abort(404);
    }

    // @codeCoverageIgnoreEnd
    // Accessors.

    /**
     * The database model stores a foreign id to the classification table,
     * but to simplify the API, this model simply returns the key as classification_code.
     *
     * @return void

     */
    public function getClassificationCodeAttribute()

    {
        if ($this->classification_id !== null) {
            $classification = Classification::find($this->classification_id);
            return $classification->key;
        }
        return null;
    }

    /**
     * The classification property is deprecated. To ensure
     * Twig template consistency, check for populated
     * classification_code and classification_level and return
     * the combination of those instead.
     *
     * @param mixed $value Incoming attribute value.
     *
     * @return string|null
     */
    public function getClassificationAttribute($value)

    {
        if (!empty($this->classification_code) && !empty($this->classification_level)) {
            return "$this->classification_code-$this->classification_level";
        } else {
            return $value;
        }
    }

    // Mutators.

    /**
     * This model exposes the classification_code attribute, but it is determined
     * by the classification_id column in the database, so set that value instead.
     *
     * @param string $value

     * @return void

     */
    public function setClassificationCodeAttribute($value): void

    {
        $classification = Classification::where('key', $value)->first();
        if ($classification !== null) {
            $this->attributes['classification_id'] = $classification->id;
        } else {
            $this->attributes['classification_id'] = null;
        }
    }

    /**
     * Intercept setting the "published" attribute, and set the
     * "published_at" timestamp if true.
     *
     * @param mixed $value Incoming value for the 'published' attribute.
     *
     * @return void

     */
    public function setPublishedAttribute($value) : void
    {
        if ($value) {
            $this->attributes['published_at'] = new Date();
        } else {
            $this->attributes['published_at'] = null;
        }
        if ($value === null) {
            $value = false;
        }
        $this->attributes['published'] = $value;
    }

    // Methods
    public function submitted_applications_count() //phpcs:ignore
    {
        return $this->submitted_applications()->count();
    }

    /**
     * Formatted and localized date and time the Job Poster closes.
     *
     * @return string[]
     */
    public function applyBy() : array
    {
        $localCloseDate = new Date($this->close_date_time); // This initializes the date object in UTC time
        $localCloseDate->setTimezone(new \DateTimeZone(self::TIMEZONE)); // Then set the time zone for display
        $displayDate = [
            'date' => $localCloseDate->format(self::DATE_FORMAT[App::getLocale()]),
            'time' => $localCloseDate->format(self::TIME_FORMAT[App::getLocale()])
        ];

        if (App::isLocale('fr')) {
            $displayDate['time'] = str_replace(['EST', 'EDT'], ['HNE', 'HAE'], $displayDate['time']);
        }

        return $displayDate;
    }

    /**
     * Return whether the Job is Open or Closed.
     * Used by the Admin Portal JobPosterCrudController.
     *
     * @return string

     */
    public function displayStatus() : string
    {
        return $this->isOpen() ? 'Open' : 'Closed';
    }

    /**
     * Check if a Job Poster is open for applications.
     *
     * @return boolean

     */
    public function isOpen() : bool
    {
        return $this->published
            && $this->open_date_time !== null
            && $this->close_date_time !== null
            && $this->open_date_time->isPast()
            && $this->close_date_time->isFuture();
    }

    /**
     * Check if a Job Poster is closed for applications.
     *
     * @return boolean

     */
    public function isClosed() : bool
    {
        return $this->published
            && $this->open_date_time !== null
            && $this->close_date_time !== null
            && $this->open_date_time->isPast()
            && $this->close_date_time->isPast();
    }

    /**
     * Calculate the remaining time a Job Poster is open.
     *
     * @return string

     */
    public function timeRemaining() : string
    {
        $interval = $this->close_date_time->diff(Date::now());

        $d = $interval->d;
        $h = $interval->h;
        $m = $interval->i;
        $s = $interval->s;

        if ($d > 0) {
            $unit = 'day';
            $count = $d;
        } elseif ($h > 0) {
            $unit = 'hour';
            $count = $h;
        } elseif ($m > 0) {
            $unit = 'minute';
            $count = $m;
        } else {
            $unit = 'second';
            $count = $s;
        }

        $key = "common/time.$unit";

        return Lang::choice($key, $count);
    }

    /**
     * Return the current status for the Job Poster.
     * Possible values are "draft", "submitted", "published" and "closed".
     *
     * @return string

     */
    public function status() : string
    {
        $status = 'draft';
        if ($this->isOpen()) {
            $status = 'published';
        } elseif ($this->isClosed()) {
            $status = 'closed';
        } elseif ($this->review_requested_at !== null) {
            $status = 'submitted';
        } else {
            $status = 'draft';
        }

        return $status;
    }

    /**
     * Return the array of values used to represent this object in an api response.
     * This array should contain no nested objects (besides translations).
     *
     * @return mixed[]
     */
    public function toApiArray(): array
    {
        $jobWithTranslations = array_merge($this->toArray(), $this->getTranslationsArray());
        return $jobWithTranslations;
    }
}


1			<?php
2
3			/**
4			* Created by Reliese Model.
5			* Date: Thu, 12 Jul 2018 22:39:27 +0000.
6			*/
7
8			namespace App\Models;
9
10			use Astrotomic\Translatable\Translatable;
11
12			use Backpack\CRUD\app\Models\Traits\CrudTrait;
13
14			use Jenssegers\Date\Date;
15
16			use Illuminate\Notifications\Notifiable;
17			use Illuminate\Support\Facades\App;
18			use Illuminate\Support\Facades\Lang;
19
20			use App\Events\JobSaved;
21
22			/**
23			* Class JobPoster
24			*
25			* @property int $id
26			* @property int $job_term_id
27			* @property string $chosen_lang
28			* @property int $term_qty
29			* @property \Jenssegers\Date\Date $open_date_time
30			* @property \Jenssegers\Date\Date $close_date_time
31			* @property \Jenssegers\Date\Date $start_date_time
32			* @property \Jenssegers\Date\Date $review_requested_at
33			* @property \Jenssegers\Date\Date $published_at
34			* @property int $department_id
35			* @property int $province_id
36			* @property int $salary_min
37			* @property int $salary_max
38			* @property int $noc
39			* @property int $classification_id
40			* @property int $classification_level
41			* @property int $security_clearance_id
42			* @property int $language_requirement_id
43			* @property boolean $remote_work_allowed
44			* @property int $manager_id
45			* @property boolean $published
46			* @property int $team_size
47			* @property array $work_env_features This should be an array of boolean flags for features, ie json of shape {[feature: string]: boolean}
48			* @property int $fast_vs_steady
49			* @property int $horizontal_vs_vertical
50			* @property int $experimental_vs_ongoing
51			* @property int $citizen_facing_vs_back_office
52			* @property int $collaborative_vs_independent
53			* @property int $telework_allowed_frequency_id
54			* @property int $flexible_hours_frequency_id
55			* @property int $travel_requirement_id
56			* @property int $overtime_requirement_id
57			* @property int $process_number
58			* @property int $priority_clearance_number
59			* @property \Jenssegers\Date\Date $loo_issuance_date
60			* @property \Jenssegers\Date\Date $created_at
61			* @property \Jenssegers\Date\Date $updated_at
62			*
63			* @property int $submitted_applications_count
64			*
65			* @property \App\Models\Lookup\Department $department
66			* @property \App\Models\Lookup\JobTerm $job_term
67			* @property \App\Models\Lookup\LanguageRequirement $language_requirement
68			* @property \App\Models\Manager $manager
69			* @property \App\Models\Lookup\Province $province
70			* @property \App\Models\Lookup\SecurityClearance $security_clearance
71			* @property \Illuminate\Database\Eloquent\Collection $criteria
72			* @property \Illuminate\Database\Eloquent\Collection $job_applications
73			* @property \Illuminate\Database\Eloquent\Collection $job_poster_key_tasks
74			* @property \Illuminate\Database\Eloquent\Collection $job_poster_questions
75			* @property \Illuminate\Database\Eloquent\Collection $job_poster_translations
76			* @property \Illuminate\Database\Eloquent\Collection $submitted_applications
77			* @property \Illuminate\Database\Eloquent\Collection $hr_advisors
78			* @property \App\Models\Lookup\Frequency $telework_allowed_frequency
79			* @property \App\Models\Lookup\Frequency $flexible_hours_frequency
80			*
81			* Localized Properties:
82			* @property string $city
83			* @property string $title
84			* @property string $dept_impact
85			* @property string $team_impact
86			* @property string $hire_impact
87			* @property string $division
88			* @property string $education
89			* @property string $work_env_description
90			* @property string $culture_summary
91			* @property string $culture_special
92			*
93			* Computed Properties
94			* @property string $classification
95			* @property string $classification_code
96			*
97			* Methods
98			* @method boolean isOpen()
99			* @method string timeRemaining()
100			* @method mixed[] toApiArray()
101			*/
102			class JobPoster extends BaseModel
103			{
104			use CrudTrait;
			0 ignored issues – show introduced 2019-11-28 13:21 UTC by Report Bug Copy Issue Report The trait `Backpack\CRUD\app\Models\Traits\CrudTrait` requires some properties which are not provided by `App\Models\JobPoster`: `$Type`, `$fakeColumns` Loading history...
105			use Translatable;
			0 ignored issues – show Bug introduced 2019-11-28 13:21 UTC by Report Bug Copy Issue Report The trait `Astrotomic\Translatable\Translatable` requires the property `$each` which is not provided by `App\Models\JobPoster`. Loading history...
106			use Notifiable;
			0 ignored issues – show Bug introduced 2019-11-28 13:21 UTC by Report Bug Copy Issue Report The trait `Illuminate\Notifications\Notifiable` requires the property `$email` which is not provided by `App\Models\JobPoster`. Loading history...
107
108			const DATE_FORMAT = [
109			'en' => 'M jS, Y',
110			'fr' => 'd M Y',
111			];
112			const TIME_FORMAT = [
113			'en' => 'h:i A T',
114			'fr' => 'H \h i T',
115			];
116			const TIMEZONE = 'America/Toronto';
117
118			/**
119			* @var string[] $translatedAttributes
120			*/
121			public $translatedAttributes = [
122			'city',
123			'title',
124			'dept_impact',
125			'team_impact',
126			'hire_impact',
127			'division',
128			'education',
129			'work_env_description',
130			'culture_summary',
131			'culture_special',
132			];
133
134			/**
135			* @var string[] $casts
136			*/
137			protected $casts = [
138			'job_term_id' => 'int',
139			'department_id' => 'int',
140			'province_id' => 'int',
141			'salary_min' => 'int',
142			'salary_max' => 'int',
143			'noc' => 'int',
144			'classification_id' => 'int',
145			'classification_level' => 'int',
146			'security_clearance_id' => 'int',
147			'language_requirement_id' => 'int',
148			'remote_work_allowed' => 'boolean',
149			'manager_id' => 'int',
150			'published' => 'boolean',
151			'team_size' => 'int',
152			'work_env_features' => 'array',
153			'fast_vs_steady' => 'int',
154			'horizontal_vs_vertical' => 'int',
155			'experimental_vs_ongoing' => 'int',
156			'citizen_facing_vs_back_office' => 'int',
157			'collaborative_vs_independent' => 'int',
158			'telework_allowed_frequency_id' => 'int',
159			'flexible_hours_frequency_id' => 'int',
160			'travel_requirement_id' => 'int',
161			'overtime_requirement_id' => 'int',
162			];
163
164			/**
165			* @var string[] $dates
166			*/
167			protected $dates = [
168			'open_date_time',
169			'close_date_time',
170			'start_date_time',
171			'review_requested_at',
172			'published_at',
173			'loo_issuance_date',
174			];
175
176			/**
177			* @var string[] $fillable
178			*/
179			protected $fillable = [
180			'job_term_id',
181			'chosen_lang',
182			'term_qty',
183			'open_date_time',
184			'close_date_time',
185			'start_date_time',
186			'department_id',
187			'province_id',
188			'salary_min',
189			'salary_max',
190			'noc',
191			'classification',
192			'classification_code',
193			'classification_level',
194			'security_clearance_id',
195			'language_requirement_id',
196			'remote_work_allowed',
197			'published',
198			'team_size',
199			'work_env_features',
200			'fast_vs_steady',
201			'horizontal_vs_vertical',
202			'experimental_vs_ongoing',
203			'citizen_facing_vs_back_office',
204			'collaborative_vs_independent',
205			'telework_allowed_frequency_id',
206			'flexible_hours_frequency_id',
207			'travel_requirement_id',
208			'overtime_requirement_id',
209			'process_number',
210			'priority_clearance_number',
211			'loo_issuance_date'
212			];
213
214			/**
215			* The attributes that should be visible in arrays.
216			* In this case, it blocks loaded relations from appearing.
217			*
218			* @var array
219			*/
220			protected $visible = [
221			'id',
222			'manager_id',
223			'chosen_lang',
224			'term_qty',
225			'open_date_time',
226			'close_date_time',
227			'start_date_time',
228			'department_id',
229			'province_id',
230			'salary_min',
231			'salary_max',
232			'noc',
233			'classification_code',
234			'classification_level',
235			'security_clearance_id',
236			'language_requirement_id',
237			'remote_work_allowed',
238			'published_at',
239			'published',
240			'review_requested_at',
241			'team_size',
242			'work_env_features',
243			'fast_vs_steady',
244			'horizontal_vs_vertical',
245			'experimental_vs_ongoing',
246			'citizen_facing_vs_back_office',
247			'collaborative_vs_independent',
248			'telework_allowed_frequency_id',
249			'flexible_hours_frequency_id',
250			'travel_requirement_id',
251			'overtime_requirement_id',
252			'process_number',
253			'priority_clearance_number',
254			'loo_issuance_date'
255			];
256
257			/**
258			* The accessors to append to the model's array form.
259			*
260			* @var mixed[] $appends
261			*/
262			protected $appends = ['classification_code'];
263
264			/**
265			* @var mixed[] $dispatchesEvents
266			*/
267			protected $dispatchesEvents = [
268			'saved' => JobSaved::class,
269			];
270
271			// @codeCoverageIgnoreStart
272			public function department() // phpcs:ignore
273			{
274			return $this->belongsTo(\App\Models\Lookup\Department::class);
275			}
276
277			public function job_term() // phpcs:ignore
278			{
279			return $this->belongsTo(\App\Models\Lookup\JobTerm::class);
280			}
281
282			public function language_requirement() // phpcs:ignore
283			{
284			return $this->belongsTo(\App\Models\Lookup\LanguageRequirement::class);
285			}
286
287			public function manager() // phpcs:ignore
288			{
289			return $this->belongsTo(\App\Models\Manager::class);
290			}
291
292			public function province() // phpcs:ignore
293			{
294			return $this->belongsTo(\App\Models\Lookup\Province::class);
295			}
296
297			public function security_clearance() // phpcs:ignore
298			{
299			return $this->belongsTo(\App\Models\Lookup\SecurityClearance::class);
300			}
301
302			public function criteria() // phpcs:ignore
303			{
304			return $this->hasMany(\App\Models\Criteria::class);
305			}
306
307			public function hr_advisors() // phpcs:ignore
308			{
309			return $this->belongsToMany(
310			\App\Models\HrAdvisor::class,
311			'claimed_jobs'
312			);
313			}
314
315			public function job_applications() // phpcs:ignore
316			{
317			return $this->hasMany(\App\Models\JobApplication::class);
318			}
319
320			public function job_poster_key_tasks() // phpcs:ignore
321			{
322			return $this->hasMany(\App\Models\JobPosterKeyTask::class);
323			}
324
325			public function job_poster_questions() // phpcs:ignore
326			{
327			return $this->hasMany(\App\Models\JobPosterQuestion::class);
328			}
329
330			public function job_poster_translations() // phpcs:ignore
331			{
332			return $this->hasMany(\App\Models\JobPosterTranslation::class);
333			}
334
335			public function telework_allowed_frequency() // phpcs:ignore
336			{
337			return $this->belongsTo(\App\Models\Lookup\Frequency::class);
338			}
339
340			public function flexible_hours_frequency() // phpcs:ignore
341			{
342			return $this->belongsTo(\App\Models\Lookup\Frequency::class);
343			}
344
345			public function travel_requirement() // phpcs:ignore
346			{
347			return $this->belongsTo(\App\Models\Lookup\TravelRequirement::class);
348			}
349
350			public function overtime_requirement() // phpcs:ignore
351			{
352			return $this->belongsTo(\App\Models\Lookup\OvertimeRequirement::class);
353			}
354
355			// Artificial Relations
356
357			/**
358			* Get all of the Job Applications submitted to this
359			* Job Poster.
360			*
361			* @return \Illuminate\Database\Eloquent\Relations\HasMany
362			*/
363			public function submitted_applications() // phpcs:ignore
364			{
365			return $this->hasMany(\App\Models\JobApplication::class)->whereDoesntHave('application_status', function ($query) : void {
366			$query->where('name', 'draft');
367			});
368			}
369
370			// Overrides
371
372			/**
373			* Retrieve the model for a bound value.
374			* Seems to be a useful workaround for providing submitted_applications_count
375			* to any bound routes that receive a jobPoster instance without using the
376			* withCount property on the model itself.
377			* See https://github.com/laravel/framework/issues/23957 for more info.
378			*
379			* @param mixed $value Value used to retrieve the model instance.
380			*
381			* @return \Illuminate\Database\Eloquent\Model\|null
382			*/
383			public function resolveRouteBinding($value) // phpcs:ignore
384			{
385			return $this->withCount('submitted_applications')->where('id', $value)->first() ?? abort(404);
386			}
387
388			// @codeCoverageIgnoreEnd
389			// Accessors.
390
391			/**
392			* The database model stores a foreign id to the classification table,
393			* but to simplify the API, this model simply returns the key as classification_code.
394			*
395			* @return void
			1 ignored issue – show Coding Style introduced 2019-07-30 18:58 UTC by Report Bug Copy Issue Report Function return type is void, but function contains return statement Loading history...
396			*/
397			public function getClassificationCodeAttribute()
			0 ignored issues – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::getClassificationCodeAttribute() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "void". Loading history...
398			{
399			if ($this->classification_id !== null) {
400			$classification = Classification::find($this->classification_id);
401			return $classification->key;
402			}
403			return null;
404			}
405
406			/**
407			* The classification property is deprecated. To ensure
408			* Twig template consistency, check for populated
409			* classification_code and classification_level and return
410			* the combination of those instead.
411			*
412			* @param mixed $value Incoming attribute value.
413			*
414			* @return string\|null
415			*/
416			public function getClassificationAttribute($value)
			0 ignored issues – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::getClassificationAttribute() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "string\|null". Loading history...
417			{
418			if (!empty($this->classification_code) && !empty($this->classification_level)) {
419			return "$this->classification_code-$this->classification_level";
420			} else {
421			return $value;
422			}
423			}
424
425			// Mutators.
426
427			/**
428			* This model exposes the classification_code attribute, but it is determined
429			* by the classification_id column in the database, so set that value instead.
430			*
431			* @param string $value
			1 ignored issue – show Coding Style Documentation introduced 2019-07-30 18:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
432			* @return void
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::setClassificationCodeAttribute() has useless @return annotation. Loading history...
433			*/
434			public function setClassificationCodeAttribute($value): void
			1 ignored issue – show Coding Style introduced 2019-07-30 18:58 UTC by Report Bug Copy Issue Report Type hint "string" missing for $value Loading history... introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::setClassificationCodeAttribute() does not have native type hint for its parameter $value but it should be possible to add it based on @param annotation "string". Loading history...
435			{
436			$classification = Classification::where('key', $value)->first();
437			if ($classification !== null) {
438			$this->attributes['classification_id'] = $classification->id;
439			} else {
440			$this->attributes['classification_id'] = null;
441			}
442			}
443
444			/**
445			* Intercept setting the "published" attribute, and set the
446			* "published_at" timestamp if true.
447			*
448			* @param mixed $value Incoming value for the 'published' attribute.
449			*
450			* @return void
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::setPublishedAttribute() has useless @return annotation. Loading history...
451			*/
452			public function setPublishedAttribute($value) : void
453			{
454			if ($value) {
455			$this->attributes['published_at'] = new Date();
456			} else {
457			$this->attributes['published_at'] = null;
458			}
459			if ($value === null) {
460			$value = false;
461			}
462			$this->attributes['published'] = $value;
463			}
464
465			// Methods
466			public function submitted_applications_count() //phpcs:ignore
467			{
468			return $this->submitted_applications()->count();
469			}
470
471			/**
472			* Formatted and localized date and time the Job Poster closes.
473			*
474			* @return string[]
475			*/
476			public function applyBy() : array
477			{
478			$localCloseDate = new Date($this->close_date_time); // This initializes the date object in UTC time
479			$localCloseDate->setTimezone(new \DateTimeZone(self::TIMEZONE)); // Then set the time zone for display
480			$displayDate = [
481			'date' => $localCloseDate->format(self::DATE_FORMAT[App::getLocale()]),
482			'time' => $localCloseDate->format(self::TIME_FORMAT[App::getLocale()])
483			];
484
485			if (App::isLocale('fr')) {
486			$displayDate['time'] = str_replace(['EST', 'EDT'], ['HNE', 'HAE'], $displayDate['time']);
487			}
488
489			return $displayDate;
490			}
491
492			/**
493			* Return whether the Job is Open or Closed.
494			* Used by the Admin Portal JobPosterCrudController.
495			*
496			* @return string
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::displayStatus() has useless @return annotation. Loading history...
497			*/
498			public function displayStatus() : string
499			{
500			return $this->isOpen() ? 'Open' : 'Closed';
501			}
502
503			/**
504			* Check if a Job Poster is open for applications.
505			*
506			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::isOpen() has useless @return annotation. Loading history...
507			*/
508			public function isOpen() : bool
509			{
510			return $this->published
511			&& $this->open_date_time !== null
512			&& $this->close_date_time !== null
513			&& $this->open_date_time->isPast()
514			&& $this->close_date_time->isFuture();
515			}
516
517			/**
518			* Check if a Job Poster is closed for applications.
519			*
520			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::isClosed() has useless @return annotation. Loading history...
521			*/
522			public function isClosed() : bool
523			{
524			return $this->published
525			&& $this->open_date_time !== null
526			&& $this->close_date_time !== null
527			&& $this->open_date_time->isPast()
528			&& $this->close_date_time->isPast();
529			}
530
531			/**
532			* Calculate the remaining time a Job Poster is open.
533			*
534			* @return string
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::timeRemaining() has useless @return annotation. Loading history...
535			*/
536			public function timeRemaining() : string
537			{
538			$interval = $this->close_date_time->diff(Date::now());
539
540			$d = $interval->d;
541			$h = $interval->h;
542			$m = $interval->i;
543			$s = $interval->s;
544
545			if ($d > 0) {
546			$unit = 'day';
547			$count = $d;
548			} elseif ($h > 0) {
549			$unit = 'hour';
550			$count = $h;
551			} elseif ($m > 0) {
552			$unit = 'minute';
553			$count = $m;
554			} else {
555			$unit = 'second';
556			$count = $s;
557			}
558
559			$key = "common/time.$unit";
560
561			return Lang::choice($key, $count);
562			}
563
564			/**
565			* Return the current status for the Job Poster.
566			* Possible values are "draft", "submitted", "published" and "closed".
567			*
568			* @return string
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::status() has useless @return annotation. Loading history...
569			*/
570			public function status() : string
571			{
572			$status = 'draft';
573			if ($this->isOpen()) {
574			$status = 'published';
575			} elseif ($this->isClosed()) {
576			$status = 'closed';
577			} elseif ($this->review_requested_at !== null) {
578			$status = 'submitted';
579			} else {
580			$status = 'draft';
581			}
582
583			return $status;
584			}
585
586			/**
587			* Return the array of values used to represent this object in an api response.
588			* This array should contain no nested objects (besides translations).
589			*
590			* @return mixed[]
591			*/
592			public function toApiArray(): array
593			{
594			$jobWithTranslations = array_merge($this->toArray(), $this->getTranslationsArray());
595			return $jobWithTranslations;
596			}
597			}
598

GCTC-NTGC / TalentCloud

Push — feature/redux-claim-job ( b0411b )

JobPoster::setClassificationCodeAttribute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like