JobPoster::status() - Code Metrics - Inspection of "change lang keys on frontend" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — feature/departments-admin-pane... ( 32fd9c...bb51c6 )

by Grant

created 2019-07-03 14:38 UTC

JobPoster::status() A

↳ Parent: JobPoster

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	10
c	1
b	0
f	0
dl	0
loc	14
ccs	10
cts	10
cp	1
rs	9.9332
cc	4
nc	4
nop	0
crap	4

<?php

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

namespace App\Models;

use App\Events\JobSaved;
use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Lang;
use Jenssegers\Date\Date;
use \Backpack\CRUD\CrudTrait;

/**
 * Class JobPoster
 *
 * @property int $id
 * @property int $job_term_id
 * @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 \Jessengers\Date\Date $published_at
 * @property int $department_id
 * @property int $province_id
 * @property int $salary_min
 * @property int $salary_max
 * @property int $noc
 * @property string $classification
 * @property string $classification_code
 * @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 \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 \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 $team_impact
 * @property string $hire_impact
 * @property string $branch
 * @property string $division
 * @property string $education
 * @property string $work_env_description
 * @property string $culture_summary
 * @property string $culture_special
 *
 * Methods
 * @method boolean isOpen()
 * @method string timeRemaining()
 * @method mixed[] toApiArray()
 */
class JobPoster extends BaseModel
{
    use CrudTrait;

    use \Dimsav\Translatable\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',
        'team_impact',
        'hire_impact',
        'branch',
        '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_code' => 'string',
        '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',
    ];

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

    /**
     * @var string[] $fillable
     */
    protected $fillable = [
        'job_term_id',
        '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',
    ];

    /**
     * The attributes that should be visible in arrays.
     * In this case, it blocks loaded relations from appearing.
     *
     * @var array

     */
    protected $visible = [
        'id',
        'manager_id',
        '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',
    ];

    /**
     * @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 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);
    }

    // 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
    // Mutators

    /**
     * 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->open_date_time->isPast()) {
            $this->attributes['published_at'] = new Date();
        } elseif ($value && $this->open_date_time->isFuture()) {
            $this->attributes['published_at'] = $this->open_date_time;
        }
        $this->attributes['published'] = $value;
    }

    // Methods
    public function submitted_applications_count()

    {
        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->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->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 App\Events\JobSaved;
11		use Illuminate\Notifications\Notifiable;
12		use Illuminate\Support\Facades\App;
13		use Illuminate\Support\Facades\Lang;
14		use Jenssegers\Date\Date;
15		use \Backpack\CRUD\CrudTrait;
16
17		/**
18		* Class JobPoster
19		*
20		* @property int $id
21		* @property int $job_term_id
22		* @property int $term_qty
23		* @property \Jenssegers\Date\Date $open_date_time
24		* @property \Jenssegers\Date\Date $close_date_time
25		* @property \Jenssegers\Date\Date $start_date_time
26		* @property \Jenssegers\Date\Date $review_requested_at
27		* @property \Jessengers\Date\Date $published_at
28		* @property int $department_id
29		* @property int $province_id
30		* @property int $salary_min
31		* @property int $salary_max
32		* @property int $noc
33		* @property string $classification
34		* @property string $classification_code
35		* @property int $classification_level
36		* @property int $security_clearance_id
37		* @property int $language_requirement_id
38		* @property boolean $remote_work_allowed
39		* @property int $manager_id
40		* @property boolean $published
41		* @property int $team_size
42		* @property array $work_env_features This should be an array of boolean flags for features, ie json of shape {[feature: string]: boolean}
43		* @property int $fast_vs_steady
44		* @property int $horizontal_vs_vertical
45		* @property int $experimental_vs_ongoing
46		* @property int $citizen_facing_vs_back_office
47		* @property int $collaborative_vs_independent
48		* @property int $telework_allowed_frequency_id
49		* @property int $flexible_hours_frequency_id
50		* @property \Jenssegers\Date\Date $created_at
51		* @property \Jenssegers\Date\Date $updated_at
52		*
53		* @property int $submitted_applications_count
54		*
55		* @property \App\Models\Lookup\Department $department
56		* @property \App\Models\Lookup\JobTerm $job_term
57		* @property \App\Models\Lookup\LanguageRequirement $language_requirement
58		* @property \App\Models\Manager $manager
59		* @property \App\Models\Lookup\Province $province
60		* @property \App\Models\Lookup\SecurityClearance $security_clearance
61		* @property \Illuminate\Database\Eloquent\Collection $criteria
62		* @property \Illuminate\Database\Eloquent\Collection $job_applications
63		* @property \Illuminate\Database\Eloquent\Collection $job_poster_key_tasks
64		* @property \Illuminate\Database\Eloquent\Collection $job_poster_questions
65		* @property \Illuminate\Database\Eloquent\Collection $job_poster_translations
66		* @property \Illuminate\Database\Eloquent\Collection $submitted_applications
67		* @property \App\Models\Lookup\Frequency $telework_allowed_frequency
68		* @property \App\Models\Lookup\Frequency $flexible_hours_frequency
69		*
70		* Localized Properties:
71		* @property string $city
72		* @property string $title
73		* @property string $team_impact
74		* @property string $hire_impact
75		* @property string $branch
76		* @property string $division
77		* @property string $education
78		* @property string $work_env_description
79		* @property string $culture_summary
80		* @property string $culture_special
81		*
82		* Methods
83		* @method boolean isOpen()
84		* @method string timeRemaining()
85		* @method mixed[] toApiArray()
86		*/
87		class JobPoster extends BaseModel
88		{
89		use CrudTrait;
		0 ignored issues – show introduced 2019-01-29 19:46 UTC by Report Bug Copy Issue Report The trait `Backpack\CRUD\CrudTrait` requires some properties which are not provided by `App\Models\JobPoster`: `$Type`, `$fakeColumns` Loading history...
90		use \Dimsav\Translatable\Translatable;
		0 ignored issues – show introduced 2018-07-26 07:01 UTC by Report Bug Copy Issue Report The trait `Dimsav\Translatable\Translatable` requires some properties which are not provided by `App\Models\JobPoster`: `$translations`, `$useTranslationFallback`, `$translationModel`, `$localeKey`, `$translationForeignKey` Loading history...
91		use Notifiable;
		0 ignored issues – show introduced 2019-01-10 15:54 UTC by Report Bug Copy Issue Report The trait `Illuminate\Notifications\Notifiable` requires some properties which are not provided by `App\Models\JobPoster`: `$email`, `$phone_number` Loading history...
92
93		const DATE_FORMAT = [
94		'en' => 'M jS, Y',
95		'fr' => 'd M Y',
96		];
97		const TIME_FORMAT = [
98		'en' => 'h:i A T',
99		'fr' => 'H \h i T',
100		];
101		const TIMEZONE = 'America/Toronto';
102
103		/**
104		* @var string[] $translatedAttributes
105		*/
106		public $translatedAttributes = [
107		'city',
108		'title',
109		'team_impact',
110		'hire_impact',
111		'branch',
112		'division',
113		'education',
114		'work_env_description',
115		'culture_summary',
116		'culture_special',
117		];
118
119		/**
120		* @var string[] $casts
121		*/
122		protected $casts = [
123		'job_term_id' => 'int',
124		'department_id' => 'int',
125		'province_id' => 'int',
126		'salary_min' => 'int',
127		'salary_max' => 'int',
128		'noc' => 'int',
129		'classification_code' => 'string',
130		'classification_level' => 'int',
131		'security_clearance_id' => 'int',
132		'language_requirement_id' => 'int',
133		'remote_work_allowed' => 'boolean',
134		'manager_id' => 'int',
135		'published' => 'boolean',
136		'team_size' => 'int',
137		'work_env_features' => 'array',
138		'fast_vs_steady' => 'int',
139		'horizontal_vs_vertical' => 'int',
140		'experimental_vs_ongoing' => 'int',
141		'citizen_facing_vs_back_office' => 'int',
142		'collaborative_vs_independent' => 'int',
143		'telework_allowed_frequency_id' => 'int',
144		'flexible_hours_frequency_id' => 'int',
145		];
146
147		/**
148		* @var string[] $dates
149		*/
150		protected $dates = [
151		'open_date_time',
152		'close_date_time',
153		'start_date_time',
154		'review_requested_at',
155		'published_at'
156		];
157
158		/**
159		* @var string[] $fillable
160		*/
161		protected $fillable = [
162		'job_term_id',
163		'term_qty',
164		'open_date_time',
165		'close_date_time',
166		'start_date_time',
167		'department_id',
168		'province_id',
169		'salary_min',
170		'salary_max',
171		'noc',
172		'classification',
173		'classification_code',
174		'classification_level',
175		'security_clearance_id',
176		'language_requirement_id',
177		'remote_work_allowed',
178		'published',
179		'team_size',
180		'work_env_features',
181		'fast_vs_steady',
182		'horizontal_vs_vertical',
183		'experimental_vs_ongoing',
184		'citizen_facing_vs_back_office',
185		'collaborative_vs_independent',
186		'telework_allowed_frequency_id',
187		'flexible_hours_frequency_id',
188		];
189
190		/**
191		* The attributes that should be visible in arrays.
192		* In this case, it blocks loaded relations from appearing.
193		*
194		* @var array
		0 ignored issues – show introduced 2019-06-12 18:44 UTC by Report Bug Copy Issue Report @var annotation of property \App\Models\JobPoster::$visible does not specify type hint for its items. Loading history...
195		*/
196		protected $visible = [
197		'id',
198		'manager_id',
199		'term_qty',
200		'open_date_time',
201		'close_date_time',
202		'start_date_time',
203		'department_id',
204		'province_id',
205		'salary_min',
206		'salary_max',
207		'noc',
208		'classification_code',
209		'classification_level',
210		'security_clearance_id',
211		'language_requirement_id',
212		'remote_work_allowed',
213		'published_at',
214		'published',
215		'review_requested_at',
216		'team_size',
217		'work_env_features',
218		'fast_vs_steady',
219		'horizontal_vs_vertical',
220		'experimental_vs_ongoing',
221		'citizen_facing_vs_back_office',
222		'collaborative_vs_independent',
223		'telework_allowed_frequency_id',
224		'flexible_hours_frequency_id',
225		];
226
227		/**
228		* @var mixed[] $dispatchesEvents
229		*/
230		protected $dispatchesEvents = [
231		'saved' => JobSaved::class,
232		];
233
234		// @codeCoverageIgnoreStart
235		public function department() // phpcs:ignore
236		{
237		return $this->belongsTo(\App\Models\Lookup\Department::class);
238		}
239
240		public function job_term() // phpcs:ignore
241		{
242		return $this->belongsTo(\App\Models\Lookup\JobTerm::class);
243		}
244
245		public function language_requirement() // phpcs:ignore
246		{
247		return $this->belongsTo(\App\Models\Lookup\LanguageRequirement::class);
248		}
249
250		public function manager() // phpcs:ignore
251		{
252		return $this->belongsTo(\App\Models\Manager::class);
253		}
254
255		public function province() // phpcs:ignore
256		{
257		return $this->belongsTo(\App\Models\Lookup\Province::class);
258		}
259
260		public function security_clearance() // phpcs:ignore
261		{
262		return $this->belongsTo(\App\Models\Lookup\SecurityClearance::class);
263		}
264
265		public function criteria() // phpcs:ignore
266		{
267		return $this->hasMany(\App\Models\Criteria::class);
268		}
269
270		public function job_applications() // phpcs:ignore
271		{
272		return $this->hasMany(\App\Models\JobApplication::class);
273		}
274
275		public function job_poster_key_tasks() // phpcs:ignore
276		{
277		return $this->hasMany(\App\Models\JobPosterKeyTask::class);
278		}
279
280		public function job_poster_questions() // phpcs:ignore
281		{
282		return $this->hasMany(\App\Models\JobPosterQuestion::class);
283		}
284
285		public function job_poster_translations() // phpcs:ignore
286		{
287		return $this->hasMany(\App\Models\JobPosterTranslation::class);
288		}
289
290		public function telework_allowed_frequency() // phpcs:ignore
291		{
292		return $this->belongsTo(\App\Models\Lookup\Frequency::class);
293		}
294
295		public function flexible_hours_frequency() // phpcs:ignore
296		{
297		return $this->belongsTo(\App\Models\Lookup\Frequency::class);
298		}
299
300		// Artificial Relations
301
302		/**
303		* Get all of the Job Applications submitted to this
304		* Job Poster.
305		*
306		* @return \Illuminate\Database\Eloquent\Relations\HasMany
307		*/
308		public function submitted_applications() // phpcs:ignore
309		{
310		return $this->hasMany(\App\Models\JobApplication::class)->whereDoesntHave('application_status', function ($query) : void {
311		$query->where('name', 'draft');
312		});
313		}
314
315		// Overrides
316
317		/**
318		* Retrieve the model for a bound value.
319		* Seems to be a useful workaround for providing submitted_applications_count
320		* to any bound routes that receive a jobPoster instance without using the
321		* withCount property on the model itself.
322		* See https://github.com/laravel/framework/issues/23957 for more info.
323		*
324		* @param mixed $value Value used to retrieve the model instance.
325		*
326		* @return \Illuminate\Database\Eloquent\Model\|null
327		*/
328		public function resolveRouteBinding($value) // phpcs:ignore
329		{
330		return $this->withCount('submitted_applications')->where('id', $value)->first() ?? abort(404);
331		}
332
333		// @codeCoverageIgnoreEnd
334		// Accessors
335		// Mutators
336
337		/**
338		* Intercept setting the "published" attribute, and set the
339		* "published_at" timestamp if true.
340		*
341		* @param mixed $value Incoming value for the 'published' attribute.
342		*
343		* @return void
344		*/
345	37	public function setPublishedAttribute($value) : void
346		{
347	37	if ($value && $this->open_date_time->isPast()) {
348	23	$this->attributes['published_at'] = new Date();
349	33	} elseif ($value && $this->open_date_time->isFuture()) {
350	1	$this->attributes['published_at'] = $this->open_date_time;
351		}
352	37	$this->attributes['published'] = $value;
353	37	}
354
355		// Methods
356	6	public function submitted_applications_count()
		1 ignored issue – show introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Method \App\Models\JobPoster::submitted_applications_count() does not have return type hint nor @return annotation for its return value. Loading history... Coding Style introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report You must use "/**" style comments for a function comment Loading history... Coding Style introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Method name "JobPoster::submitted_applications_count" is not in camel caps format Loading history...
357		{
358	6	return $this->submitted_applications()->count();
359		}
360
361		/**
362		* Formatted and localized date and time the Job Poster closes.
363		*
364		* @return string[]
365		*/
366	1	public function applyBy() : array
367		{
368	1	$localCloseDate = new Date($this->close_date_time); // This initializes the date object in UTC time
369	1	$localCloseDate->setTimezone(new \DateTimeZone(self::TIMEZONE)); // Then set the time zone for display
370		$displayDate = [
371	1	'date' => $localCloseDate->format(self::DATE_FORMAT[App::getLocale()]),
372	1	'time' => $localCloseDate->format(self::TIME_FORMAT[App::getLocale()])
373		];
374
375	1	if (App::isLocale('fr')) {
376		$displayDate['time'] = str_replace(['EST', 'EDT'], ['HNE', 'HAE'], $displayDate['time']);
377		}
378
379	1	return $displayDate;
380		}
381
382		/**
383		* Return whether the Job is Open or Closed.
384		* Used by the Admin Portal JobPosterCrudController.
385		*
386		* @return string
387		*/
388		public function displayStatus() : string
389		{
390		return $this->isOpen() ? 'Open' : 'Closed';
391		}
392
393		/**
394		* Check if a Job Poster is open for applications.
395		*
396		* @return boolean
397		*/
398	6	public function isOpen() : bool
399		{
400	6	return $this->published
401	6	&& $this->open_date_time->isPast()
402	6	&& $this->close_date_time->isFuture();
403		}
404
405		/**
406		* Check if a Job Poster is closed for applications.
407		*
408		* @return boolean
409		*/
410	4	public function isClosed() : bool
411		{
412	4	return $this->published
413	4	&& $this->open_date_time->isPast()
414	4	&& $this->close_date_time->isPast();
415		}
416
417		/**
418		* Calculate the remaining time a Job Poster is open.
419		*
420		* @return string
421		*/
422	1	public function timeRemaining() : string
423		{
424	1	$interval = $this->close_date_time->diff(Date::now());
425
426	1	$d = $interval->d;
427	1	$h = $interval->h;
428	1	$m = $interval->i;
429	1	$s = $interval->s;
430
431	1	if ($d > 0) {
432	1	$unit = 'day';
433	1	$count = $d;
434	1	} elseif ($h > 0) {
435	1	$unit = 'hour';
436	1	$count = $h;
437	1	} elseif ($m > 0) {
438	1	$unit = 'minute';
439	1	$count = $m;
440		} else {
441		$unit = 'second';
442		$count = $s;
443		}
444
445	1	$key = "common/time.$unit";
446
447	1	return Lang::choice($key, $count);
448		}
449
450		/**
451		* Return the current status for the Job Poster.
452		* Possible values are "draft", "submitted", "published" and "closed".
453		*
454		* @return string
455		*/
456	3	public function status() : string
457		{
458	3	$status = 'draft';
459	3	if ($this->isOpen()) {
460	1	$status = 'published';
461	3	} elseif ($this->isClosed()) {
462	1	$status = 'closed';
463	3	} elseif ($this->review_requested_at !== null) {
464	3	$status = 'submitted';
465		} else {
466	1	$status = 'draft';
467		}
468
469	3	return $status;
470		}
471
472		/**
473		* Return the array of values used to represent this object in an api response.
474		* This array should contain no nested objects (besides translations).
475		*
476		* @return mixed[]
477		*/
478	4	public function toApiArray(): array
479		{
480	4	$jobWithTranslations = array_merge($this->toArray(), $this->getTranslationsArray());
481	4	return $jobWithTranslations;
482		}
483		}
484

GCTC-NTGC / TalentCloud

Push — feature/departments-admin-pane... ( 32fd9c...bb51c6 )

JobPoster::status() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like