JobPoster::setPublishedAttribute() - Code Metrics - Inspection of "Merge branch 'release/1.0.8'" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2c3721...94fb22 )

by Grant

created 2019-03-22 21:06 UTC

JobPoster::setPublishedAttribute() A

↳ Parent: JobPoster

Complexity

Conditions	5
Paths	3

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	5

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	8
rs	9.6111
c	0
b	0
f	0
ccs	6
cts	6
cp	1
cc	5
nc	3
nop	1
crap	5

<?php

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

namespace App\Models;

use App\Events\JobSaved;
use App\Models\JobApplication;
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 int $security_clearance_id
 * @property int $language_requirement_id
 * @property boolean $remote_work_allowed
 * @property int $manager_id
 * @property boolean $published
 * @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[ScreeningPlan] $screening_plans
 *
 * Localized Properties:
 * @property string $city
 * @property string $title
 * @property string $impact
 * @property string $branch
 * @property string $division
 * @property string $education
 *
 * Methods
 * @method boolean isOpen()
 * @method string timeRemaining()
 */

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',
        'impact',
        'branch',
        'division',
        'education'
    ];

    /**
     * @var string[] $casts
     */
    protected $casts = [
        'job_term_id' => 'int',
        'department_id' => 'int',
        'province_id' => 'int',
        'salary_min' => 'int',
        'salary_max' => 'int',
        'noc' => 'int',
        'security_clearance_id' => 'int',
        'language_requirement_id' => 'int',
        'remote_work_allowed' => 'boolean',
        'manager_id' => 'int',
        'published' => 'boolean'
    ];

    /**
     * @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',
        'security_clearance_id',
        'language_requirement_id',
        'remote_work_allowed',
    ];

    /**
     * @var string[] $fillable
     */
    protected $withCount = ['submitted_applications'];

    /**
     * @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 screening_plans() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\ScreeningPlan::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');
        });
    }

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


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 App\Models\JobApplication;
12		use Illuminate\Notifications\Notifiable;
13		use Illuminate\Support\Facades\App;
14		use Illuminate\Support\Facades\Lang;
15		use Jenssegers\Date\Date;
16		use \Backpack\CRUD\CrudTrait;
17
18		/**
19		* Class JobPoster
20		*
21		* @property int $id
22		* @property int $job_term_id
23		* @property int $term_qty
24		* @property \Jenssegers\Date\Date $open_date_time
25		* @property \Jenssegers\Date\Date $close_date_time
26		* @property \Jenssegers\Date\Date $start_date_time
27		* @property \Jenssegers\Date\Date $review_requested_at
28		* @property \Jessengers\Date\Date $published_at
29		* @property int $department_id
30		* @property int $province_id
31		* @property int $salary_min
32		* @property int $salary_max
33		* @property int $noc
34		* @property string $classification
35		* @property int $security_clearance_id
36		* @property int $language_requirement_id
37		* @property boolean $remote_work_allowed
38		* @property int $manager_id
39		* @property boolean $published
40		* @property \Jenssegers\Date\Date $created_at
41		* @property \Jenssegers\Date\Date $updated_at
42		*
43		* @property int $submitted_applications_count
44		*
45		* @property \App\Models\Lookup\Department $department
46		* @property \App\Models\Lookup\JobTerm $job_term
47		* @property \App\Models\Lookup\LanguageRequirement $language_requirement
48		* @property \App\Models\Manager $manager
49		* @property \App\Models\Lookup\Province $province
50		* @property \App\Models\Lookup\SecurityClearance $security_clearance
51		* @property \Illuminate\Database\Eloquent\Collection $criteria
52		* @property \Illuminate\Database\Eloquent\Collection $job_applications
53		* @property \Illuminate\Database\Eloquent\Collection $job_poster_key_tasks
54		* @property \Illuminate\Database\Eloquent\Collection $job_poster_questions
55		* @property \Illuminate\Database\Eloquent\Collection $job_poster_translations
56		* @property \Illuminate\Database\Eloquent\Collection $submitted_applications
57		* @property \Illuminate\Database\Eloquent\Collection[ScreeningPlan] $screening_plans
58		*
59		* Localized Properties:
60		* @property string $city
61		* @property string $title
62		* @property string $impact
63		* @property string $branch
64		* @property string $division
65		* @property string $education
66		*
67		* Methods
68		* @method boolean isOpen()
69		* @method string timeRemaining()
70		*/
		0 ignored issues – show Documentation Bug introduced 2018-12-19 22:24 UTC by Report Bug Copy Issue Report The doc comment `\Illuminate\Database\Elo...llection[ScreeningPlan]` at position `1` could not be parsed: Expected ']' at position 1, but found '['. Loading history...
71		class JobPoster extends BaseModel
72		{
73		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...
74		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...
75		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...
76
77		const DATE_FORMAT = [
78		'en' => 'M jS, Y',
79		'fr' => 'd M Y',
80		];
81		const TIME_FORMAT = [
82		'en' => 'h:i A T',
83		'fr' => 'H \h i T',
84		];
85		const TIMEZONE = 'America/Toronto';
86
87		/**
88		* @var string[] $translatedAttributes
89		*/
90		public $translatedAttributes = [
91		'city',
92		'title',
93		'impact',
94		'branch',
95		'division',
96		'education'
97		];
98
99		/**
100		* @var string[] $casts
101		*/
102		protected $casts = [
103		'job_term_id' => 'int',
104		'department_id' => 'int',
105		'province_id' => 'int',
106		'salary_min' => 'int',
107		'salary_max' => 'int',
108		'noc' => 'int',
109		'security_clearance_id' => 'int',
110		'language_requirement_id' => 'int',
111		'remote_work_allowed' => 'boolean',
112		'manager_id' => 'int',
113		'published' => 'boolean'
114		];
115
116		/**
117		* @var string[] $dates
118		*/
119		protected $dates = [
120		'open_date_time',
121		'close_date_time',
122		'start_date_time',
123		'review_requested_at',
124		'published_at'
125		];
126
127		/**
128		* @var string[] $fillable
129		*/
130		protected $fillable = [
131		'job_term_id',
132		'term_qty',
133		'open_date_time',
134		'close_date_time',
135		'start_date_time',
136		'department_id',
137		'province_id',
138		'salary_min',
139		'salary_max',
140		'noc',
141		'classification',
142		'security_clearance_id',
143		'language_requirement_id',
144		'remote_work_allowed',
145		];
146
147		/**
148		* @var string[] $fillable
149		*/
150		protected $withCount = ['submitted_applications'];
151
152		/**
153		* @var mixed[] $dispatchesEvents
154		*/
155		protected $dispatchesEvents = [
156		'saved' => JobSaved::class,
157		];
158
159		// @codeCoverageIgnoreStart
160
161		public function department() // phpcs:ignore
162		{
163		return $this->belongsTo(\App\Models\Lookup\Department::class);
164		}
165
166		public function job_term() // phpcs:ignore
167		{
168		return $this->belongsTo(\App\Models\Lookup\JobTerm::class);
169		}
170
171		public function language_requirement() // phpcs:ignore
172		{
173		return $this->belongsTo(\App\Models\Lookup\LanguageRequirement::class);
174		}
175
176		public function manager() // phpcs:ignore
177		{
178		return $this->belongsTo(\App\Models\Manager::class);
179		}
180
181		public function province() // phpcs:ignore
182		{
183		return $this->belongsTo(\App\Models\Lookup\Province::class);
184		}
185
186		public function security_clearance() // phpcs:ignore
187		{
188		return $this->belongsTo(\App\Models\Lookup\SecurityClearance::class);
189		}
190
191		public function criteria() // phpcs:ignore
192		{
193		return $this->hasMany(\App\Models\Criteria::class);
194		}
195
196		public function job_applications() // phpcs:ignore
197		{
198		return $this->hasMany(\App\Models\JobApplication::class);
199		}
200
201		public function job_poster_key_tasks() // phpcs:ignore
202		{
203		return $this->hasMany(\App\Models\JobPosterKeyTask::class);
204		}
205
206		public function job_poster_questions() // phpcs:ignore
207		{
208		return $this->hasMany(\App\Models\JobPosterQuestion::class);
209		}
210
211		public function job_poster_translations() // phpcs:ignore
212		{
213		return $this->hasMany(\App\Models\JobPosterTranslation::class);
214		}
215
216		public function screening_plans() // phpcs:ignore
217		{
218		return $this->hasMany(\App\Models\ScreeningPlan::class);
219		}
220
221		// Artificial Relations
222
223		/**
224		* Get all of the Job Applications submitted to this
225		* Job Poster.
226		*
227		* @return \Illuminate\Database\Eloquent\Relations\HasMany
228		*/
229		public function submitted_applications() // phpcs:ignore
230		{
231		return $this->hasMany(\App\Models\JobApplication::class)->whereDoesntHave('application_status', function ($query) : void {
232		$query->where('name', 'draft');
233		});
234		}
235
236		// @codeCoverageIgnoreEnd
237
238		// Accessors
239
240		// Mutators
241
242		/**
243		* Intercept setting the "published" attribute, and set the
244		* "published_at" timestamp if true.
245		*
246		* @param mixed $value Incoming value for the 'published' attribute.
247		*
248		* @return void
249		*/
250	22	public function setPublishedAttribute($value) : void
251		{
252	22	if ($value && $this->open_date_time->isPast()) {
253	17	$this->attributes['published_at'] = new Date();
254	19	} elseif ($value && $this->open_date_time->isFuture()) {
255	1	$this->attributes['published_at'] = $this->open_date_time;
256		}
257	22	$this->attributes['published'] = $value;
258	22	}
259
260		// Methods
261
262	4	public function submitted_applications_count()
		1 ignored issue – show 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... 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...
263		{
264	4	return $this->submitted_applications()->count();
265		}
266
267		/**
268		* Formatted and localized date and time the Job Poster closes.
269		*
270		* @return string[]
271		*/
272	1	public function applyBy() : array
273		{
274	1	$localCloseDate = new Date($this->close_date_time); // This initializes the date object in UTC time
275	1	$localCloseDate->setTimezone(new \DateTimeZone(self::TIMEZONE)); // Then set the time zone for display
276		$displayDate = [
277	1	'date' => $localCloseDate->format(self::DATE_FORMAT[App::getLocale()]),
278	1	'time' => $localCloseDate->format(self::TIME_FORMAT[App::getLocale()])
279		];
280
281	1	if (App::isLocale('fr')) {
282		$displayDate['time'] = str_replace(['EST', 'EDT'], ['HNE', 'HAE'], $displayDate['time']);
283		}
284
285	1	return $displayDate;
286		}
287
288		/**
289		* Return whether the Job is Open or Closed.
290		* Used by the Admin Portal JobPosterCrudController.
291		*
292		* @return string
293		*/
294		public function displayStatus() : string
295		{
296		return $this->isOpen() ? 'Open' : 'Closed';
297		}
298
299		/**
300		* Check if a Job Poster is open for applications.
301		*
302		* @return boolean
303		*/
304	6	public function isOpen() : bool
305		{
306	6	return $this->published
307	6	&& $this->open_date_time->isPast()
308	6	&& $this->close_date_time->isFuture();
309		}
310
311		/**
312		* Check if a Job Poster is closed for applications.
313		*
314		* @return boolean
315		*/
316	4	public function isClosed() : bool
317		{
318	4	return $this->published
319	4	&& $this->open_date_time->isPast()
320	4	&& $this->close_date_time->isPast();
321		}
322
323		/**
324		* Calculate the remaining time a Job Poster is open.
325		*
326		* @return string
327		*/
328	1	public function timeRemaining() : string
329		{
330	1	$interval = $this->close_date_time->diff(Date::now());
331
332	1	$d = $interval->d;
333	1	$h = $interval->h;
334	1	$m = $interval->i;
335	1	$s = $interval->s;
336
337	1	if ($d > 0) {
338	1	$unit = 'day';
339	1	$count = $d;
340	1	} elseif ($h > 0) {
341	1	$unit = 'hour';
342	1	$count = $h;
343	1	} elseif ($m > 0) {
344	1	$unit = 'minute';
345	1	$count = $m;
346		} else {
347	1	$unit = 'second';
348	1	$count = $s;
349		}
350
351	1	$key = "common/time.$unit";
352
353	1	return Lang::choice($key, $count);
354		}
355
356		/**
357		* Return the current status for the Job Poster.
358		* Possible values are "draft", "submitted", "published" and "closed".
359		*
360		* @return string
361		*/
362	3	public function status() : string
363		{
364	3	$status = 'draft';
365	3	if ($this->isOpen()) {
366	1	$status = 'published';
367	3	} elseif ($this->isClosed()) {
368	1	$status = 'closed';
369	3	} elseif ($this->review_requested_at !== null) {
370	3	$status = 'submitted';
371		} else {
372	1	$status = 'draft';
373		}
374
375	3	return $status;
376		}
377		}
378

GCTC-NTGC / TalentCloud

Push — master ( 2c3721...94fb22 )

JobPoster::setPublishedAttribute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like