User::department() - Code Metrics - Inspection of "Include some more fake data for storybook" - GCTC-NTGC/TalentCloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — feature/application-review-ui ( afbf92 )

by Chris
created 2020-08-24 14:14 UTC
User::department() A

↳ Parent: User
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php

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

namespace App\Models;

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

/**
 * 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 string $google2fa_secret
 * @property array $recovery_codes
 * @property int $department_id
 * @property string $contact_language
 * @property boolean $job_alerts
 * @property \Jenssegers\Date\Date $recovery_codes_generation_date
 * @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
 * @property \App\Models\Lookup\Department $department
 */
class User extends BaseModel implements
    // Laravel contracts for native login.
    AuthenticatableContract,
    CanResetPasswordContract,
    // Contract for use with Gates and Policies.
    AuthorizableContract
{

    // 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;
    // Trait for 2FA device memory.
    use RememberDeviceTrait;

    protected $casts = [
        'is_confirmed' => 'boolean',
        'is_priority' => 'boolean',
        'user_role_id' => 'int',
        'email' => 'string',
        'gov_email' => 'string',
        'not_in_gov' => 'boolean',
        'department_id' => 'int',
        'contact_language' => 'string',
        'job_alerts' => 'boolean',
    ];

    /**
     * @var string[] $dates
     */
    protected $dates = [
        'recovery_codes_generation_date',
    ];

    protected $fillable = [
        'first_name',
        'last_name',
        'email',
        'password',
        'is_priority',
        'gov_email',
        'not_in_gov',
        'google2fa_secret',
        'department_id',
        'contact_language',
        'job_alerts',
    ];

    protected $with = ['user_role'];

    protected $hidden = [
        'password',
        'remember_token',
        'remember_device_token',
        'recovery_codes_generation_date',
        'google2fa_secret',
        'recovery_codes',
    ];

    /**
     * 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 department()
    {
        return $this->belongsTo(\App\Models\Lookup\Department::class);
    }

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

    }

    /**
     * Encrypt the user's google_2fa secret.
     *
     * @param  string  $value
     * @return string
     */
    public function setGoogle2faSecretAttribute($value)
    {
        $this->attributes['google2fa_secret'] = encrypt($value);
        $this->attributes['google2fa_secret'] = /** @scrutinizer ignore-call */ encrypt($value);
    }

    /**
     * Decrypt the user's google_2fa secret.
     *
     * @param  string  $value
     * @return string
     */
    public function getGoogle2faSecretAttribute($value)
    {
        if (!empty($value)) {
            return decrypt($value);
            return /** @scrutinizer ignore-call */ decrypt($value);
        }
        return null;
    }

    /**
     * Encrypt and serialize the user's recovery codes.
     *
     * @param  string[]  $value
     * @return void
     */
    public function setRecoveryCodesAttribute($value)
    {
        $this->attributes['recovery_codes'] = encrypt($value);
        $this->attributes['recovery_codes'] = /** @scrutinizer ignore-call */ encrypt($value);
    }

    /**
     * Decrypt and deserialize the user's recovery codes.
     *
     * @param  string  $value
     * @return string[]
     */
    public function getRecoveryCodesAttribute($value)
    {
        if (!empty($value)) {
            return decrypt($value);
            return /** @scrutinizer ignore-call */ decrypt($value);
        }
        return null;
    }

    // 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->key === '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
    {
        return $this->user_role->key === 'hr_advisor' || $this->isAdmin();
    }

    /**
     * Returns true if this user has the Admin role.
     *
     * @return boolean
     */
    public function isAdmin(): bool
    {
        return $this->user_role->key === '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('key', $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;
    }
}

GCTC-NTGC / TalentCloud

Push — feature/application-review-ui ( afbf92 )

User::department() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
