User::isHrAdvisor() - 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

User::isHrAdvisor() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	1
dl	0
loc	4
rs	10
c	1
b	0
f	1
cc	1
nc	1
nop	0

<?php

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

namespace App\Models;

use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Notifications\Notifiable;
use App\Events\UserCreated;
use App\Events\UserUpdated;
use App\Notifications\ResetPasswordNotification;
use App\CRUD\TalentCloudCrudTrait as CrudTrait;

/**
 * Class User
 *
 * @property int $id
 * @property string $email
 * @property string $first_name
 * @property string $last_name
 * @property string $password
 * @property boolean $is_confirmed
 * @property boolean $is_priority
 * @property int $user_role_id
 * @property string $gov_email
 * @property boolean $not_in_gov
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * @property \App\Models\Applicant $applicant
 * @property \App\Models\Manager $manager
 * @property \App\Models\HrAdvisor $hr_advisor
 * @property \App\Models\ProfilePic $profile_pic
 * @property \App\Models\UserRole $user_role
 */
class User extends BaseModel implements
    // Laravel contracts for native login.
    AuthenticatableContract,
    CanResetPasswordContract,
    // Contract for use with Gates and Policies.
    AuthorizableContract
    // Custom contract for use with openid login.
    // \App\Services\Auth\Contracts\OidcAuthenticatable.
{

    // Traits for Laravel basic authentication.
    use Authenticatable;
    use CanResetPassword;
    // Trait for working with Gates and Policies.
    use Authorizable;
    // Trait for notifications.
    use Notifiable;
    // Trait for Backpack.
    use CrudTrait;

    protected $casts = [

        'is_confirmed' => 'boolean',
        'is_priority' => 'boolean',
        'user_role_id' => 'int',
        'email' => 'string',
        'gov_email' => 'string',
        'not_in_gov' => 'boolean',
    ];

    protected $fillable = [

        'first_name', 'last_name', 'email', 'password', 'is_priority', 'gov_email', 'not_in_gov'
    ];

    protected $with = ['user_role'];


    protected $hidden = [

        'password', 'remember_token',
    ];

    /**
     * The event map for the model.
     *
     * @var array
     */
    protected $dispatchesEvents = [
        'created' => UserCreated::class,
        'updated' => UserUpdated::class,
    ];

    public function applicant() //phpcs:ignore
    {
        return $this->hasOne(\App\Models\Applicant::class);
    }

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

    public function hr_advisor() //phpcs:ignore
    {
        return $this->hasOne(\App\Models\HrAdvisor::class);
    }

    public function profile_pic() //phpcs:ignore
    {
        return $this->hasOne(\App\Models\ProfilePic::class);
    }

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

    public function setIsPriorityAttribute($value)

    {
        if ($value === null) {
            $value = false;
        }
        $this->attributes['is_priority'] = $value;
    }

    // Role related functions.

    /**
     * Returns true if this user has the Applicant role.
     *
     * @return boolean

     */
    public function isApplicant(): bool
    {
        // Currently, every user can create an Applicant profile and apply to jobs.
        return true;
    }

    /**
     * Returns true if this user has the upgradedManager role.
     *
     * @return boolean

     */
    public function isUpgradedManager(): bool
    {
        return $this->isAdmin() || $this->user_role->name === 'upgradedManager';
    }

    /**
     * Returns true this user has the demoManager role.
     *
     * @return boolean

     */
    public function isDemoManager(): bool
    {
        // Currently, every non-upgradedManager user can be considered a demoManager.
        return !$this->isUpgradedManager();
    }

    /**
     * Returns true if this user has the demoManager or upgradedManager role.
     *
     * @return boolean

     */
    public function isManager(): bool
    {
        // Currently, every user can use the Manager portal as a demoManager.
        return $this->isDemoManager() || $this->isUpgradedManager();
    }

    /**
     * Returns true if this user has the hr_advisor role.
     *
     * @return boolean

     */
    public function isHrAdvisor(): bool
    {
        // Currently, every user can use the Manager portal as a demoManager.
        return $this->user_role->name === 'hr_advisor';
    }

    /**
     * Returns true if this user has the Admin role.
     *
     * @return boolean

     */
    public function isAdmin(): bool
    {
        return $this->user_role->name === 'admin';
    }

    /**
    * Check if the user has the specified role.
    * @param string $role This may be either 'applicant', 'manager', 'hr_advisor' or 'admin'.
    * @return boolean
    */
    public function hasRole($role)

    {
        switch ($role) {
            case 'applicant':
                return $this->isApplicant();
            case 'manager':
                return $this->isManager();
            case 'hr_advisor':
                return $this->isHrAdvisor();
            case 'admin':
                return $this->isAdmin();
            default:
                return false;
        }
    }

    /**
     * Set this user to the specified role.
     *
     * @param string $role Must be either 'applicant', 'manager', 'hr_advisor' or 'admin'.
    * @return void

    */
    public function setRole(string $role): void
    {
        $this->user_role()->associate(UserRole::where('name', $role)->firstOrFail());
    }

    /**
     * OVERRIDE
     * Send the password reset notification.
     *
     * @param  string  $token

     *
     * @return void

     */
    public function sendPasswordResetNotification($token): void

    {
        $this->notify(new ResetPasswordNotification($token));
    }

    /**
     * Gov identity has been confirmed either if:
     *  - they have confirmed to NOT be in government,
     *  - OR they've added a gov email.
     *
     * @return boolean

     */
    public function isGovIdentityConfirmed(): bool
    {
        return $this->not_in_gov || !empty($this->gov_email);
    }

    /**
     * Returns a user's full name.
     *
     * @return string

    */
    public function getFullNameAttribute(): string
    {
        return $this->first_name . ' ' . $this->last_name;
    }
}


1			<?php
2
3			/**
4			* Created by Reliese Model.
5			* Date: Thu, 12 Jul 2018 22:39:28 +0000.
6			*/
7
8			namespace App\Models;
9
10			use Illuminate\Auth\Authenticatable;
11			use Illuminate\Auth\Passwords\CanResetPassword;
12			use Illuminate\Foundation\Auth\Access\Authorizable;
13			use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
14			use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
15			use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
16			use Illuminate\Notifications\Notifiable;
17			use App\Events\UserCreated;
18			use App\Events\UserUpdated;
19			use App\Notifications\ResetPasswordNotification;
20			use App\CRUD\TalentCloudCrudTrait as CrudTrait;
21
22			/**
23			* Class User
24			*
25			* @property int $id
26			* @property string $email
27			* @property string $first_name
28			* @property string $last_name
29			* @property string $password
30			* @property boolean $is_confirmed
31			* @property boolean $is_priority
32			* @property int $user_role_id
33			* @property string $gov_email
34			* @property boolean $not_in_gov
35			* @property \Jenssegers\Date\Date $created_at
36			* @property \Jenssegers\Date\Date $updated_at
37			*
38			* @property \App\Models\Applicant $applicant
39			* @property \App\Models\Manager $manager
40			* @property \App\Models\HrAdvisor $hr_advisor
41			* @property \App\Models\ProfilePic $profile_pic
42			* @property \App\Models\UserRole $user_role
43			*/
44			class User extends BaseModel implements
45			// Laravel contracts for native login.
46			AuthenticatableContract,
47			CanResetPasswordContract,
48			// Contract for use with Gates and Policies.
49			AuthorizableContract
50			// Custom contract for use with openid login.
51			// \App\Services\Auth\Contracts\OidcAuthenticatable.
52			{
53
54			// Traits for Laravel basic authentication.
55			use Authenticatable;
56			use CanResetPassword;
57			// Trait for working with Gates and Policies.
58			use Authorizable;
59			// Trait for notifications.
60			use Notifiable;
61			// Trait for Backpack.
62			use CrudTrait;
63
64			protected $casts = [
			1 ignored issue – show Coding Style Documentation introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
65			'is_confirmed' => 'boolean',
66			'is_priority' => 'boolean',
67			'user_role_id' => 'int',
68			'email' => 'string',
69			'gov_email' => 'string',
70			'not_in_gov' => 'boolean',
71			];
72
73			protected $fillable = [
			1 ignored issue – show Coding Style Documentation introduced 2019-11-28 20:07 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
74			'first_name', 'last_name', 'email', 'password', 'is_priority', 'gov_email', 'not_in_gov'
75			];
76
77			protected $with = ['user_role'];
			1 ignored issue – show Coding Style Documentation introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
78
79			protected $hidden = [
			1 ignored issue – show Coding Style Documentation introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Missing member variable doc comment Loading history...
80			'password', 'remember_token',
81			];
82
83			/**
84			* The event map for the model.
85			*
86			* @var array
87			*/
88			protected $dispatchesEvents = [
89			'created' => UserCreated::class,
90			'updated' => UserUpdated::class,
91			];
92
93			public function applicant() //phpcs:ignore
94			{
95			return $this->hasOne(\App\Models\Applicant::class);
96			}
97
98			public function manager() //phpcs:ignore
99			{
100			return $this->hasOne(\App\Models\Manager::class);
101			}
102
103			public function hr_advisor() //phpcs:ignore
104			{
105			return $this->hasOne(\App\Models\HrAdvisor::class);
106			}
107
108			public function profile_pic() //phpcs:ignore
109			{
110			return $this->hasOne(\App\Models\ProfilePic::class);
111			}
112
113			public function user_role() //phpcs:ignore
114			{
115			return $this->belongsTo(\App\Models\UserRole::class);
116			}
117
118			public function setIsPriorityAttribute($value)
			1 ignored issue – show Coding Style Documentation introduced 2019-09-30 20:11 UTC by Report Bug Copy Issue Report Missing doc comment for function setIsPriorityAttribute() Loading history... introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::setIsPriorityAttribute() does not have parameter type hint nor @param annotation for its parameter $value. Loading history... introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::setIsPriorityAttribute() does not have void return type hint. Loading history...
119			{
120			if ($value === null) {
121			$value = false;
122			}
123			$this->attributes['is_priority'] = $value;
124			}
125
126			// Role related functions.
127
128			/**
129			* Returns true if this user has the Applicant role.
130			*
131			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isApplicant() has useless @return annotation. Loading history...
132			*/
133			public function isApplicant(): bool
134			{
135			// Currently, every user can create an Applicant profile and apply to jobs.
136			return true;
137			}
138
139			/**
140			* Returns true if this user has the upgradedManager role.
141			*
142			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isUpgradedManager() has useless @return annotation. Loading history...
143			*/
144			public function isUpgradedManager(): bool
145			{
146			return $this->isAdmin() \|\| $this->user_role->name === 'upgradedManager';
147			}
148
149			/**
150			* Returns true this user has the demoManager role.
151			*
152			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isDemoManager() has useless @return annotation. Loading history...
153			*/
154			public function isDemoManager(): bool
155			{
156			// Currently, every non-upgradedManager user can be considered a demoManager.
157			return !$this->isUpgradedManager();
158			}
159
160			/**
161			* Returns true if this user has the demoManager or upgradedManager role.
162			*
163			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isManager() has useless @return annotation. Loading history...
164			*/
165			public function isManager(): bool
166			{
167			// Currently, every user can use the Manager portal as a demoManager.
168			return $this->isDemoManager() \|\| $this->isUpgradedManager();
169			}
170
171			/**
172			* Returns true if this user has the hr_advisor role.
173			*
174			* @return boolean
			1 ignored issue – show introduced 2019-12-05 23:15 UTC by Report Bug Copy Issue Report Method \App\Models\User::isHrAdvisor() has useless @return annotation. Loading history...
175			*/
176			public function isHrAdvisor(): bool
177			{
178			// Currently, every user can use the Manager portal as a demoManager.
179			return $this->user_role->name === 'hr_advisor';
180			}
181
182			/**
183			* Returns true if this user has the Admin role.
184			*
185			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isAdmin() has useless @return annotation. Loading history...
186			*/
187			public function isAdmin(): bool
188			{
189			return $this->user_role->name === 'admin';
190			}
191
192			/**
193			* Check if the user has the specified role.
194			* @param string $role This may be either 'applicant', 'manager', 'hr_advisor' or 'admin'.
195			* @return boolean
196			*/
197			public function hasRole($role)
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::hasRole() does not have native type hint for its parameter $role but it should be possible to add it based on @param annotation "string". Loading history... introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::hasRole() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "boolean". Loading history... Coding Style introduced 2019-11-28 20:07 UTC by Report Bug Copy Issue Report Type hint "string" missing for $role Loading history...
198			{
199			switch ($role) {
200			case 'applicant':
201			return $this->isApplicant();
202			case 'manager':
203			return $this->isManager();
204			case 'hr_advisor':
205			return $this->isHrAdvisor();
206			case 'admin':
207			return $this->isAdmin();
208			default:
209			return false;
210			}
211			}
212
213			/**
214			* Set this user to the specified role.
215			*
216			* @param string $role Must be either 'applicant', 'manager', 'hr_advisor' or 'admin'.
217			* @return void
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::setRole() has useless @return annotation. Loading history...
218			*/
219			public function setRole(string $role): void
220			{
221			$this->user_role()->associate(UserRole::where('name', $role)->firstOrFail());
222			}
223
224			/**
225			* OVERRIDE
226			* Send the password reset notification.
227			*
228			* @param string $token
			2 ignored issues – show Coding Style Documentation introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 2 found Loading history...
229			*
230			* @return void
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::sendPasswordResetNotification() has useless @return annotation. Loading history...
231			*/
232			public function sendPasswordResetNotification($token): void
			1 ignored issue – show Coding Style introduced 2019-03-09 13:58 UTC by Report Bug Copy Issue Report Type hint "string" missing for $token Loading history... introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::sendPasswordResetNotification() does not have native type hint for its parameter $token but it should be possible to add it based on @param annotation "string". Loading history...
233			{
234			$this->notify(new ResetPasswordNotification($token));
235			}
236
237			/**
238			* Gov identity has been confirmed either if:
239			* - they have confirmed to NOT be in government,
240			* - OR they've added a gov email.
241			*
242			* @return boolean
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::isGovIdentityConfirmed() has useless @return annotation. Loading history...
243			*/
244			public function isGovIdentityConfirmed(): bool
245			{
246			return $this->not_in_gov \|\| !empty($this->gov_email);
247			}
248
249			/**
250			* Returns a user's full name.
251			*
252			* @return string
			1 ignored issue – show introduced 2019-12-05 15:07 UTC by Report Bug Copy Issue Report Method \App\Models\User::getFullNameAttribute() has useless @return annotation. Loading history...
253			*/
254			public function getFullNameAttribute(): string
255			{
256			return $this->first_name . ' ' . $this->last_name;
257			}
258			}
259

GCTC-NTGC / TalentCloud

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

User::isHrAdvisor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like