App\Models\User

Complexity

Total Complexity

19

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Test Coverage

Coverage

38.1%

Importance

Changes	2
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	hasRole()	0	11	4
A	profile_pic()	0	3	1
A	isApplicant()	0	4	1
A	setRole()	0	3	1
A	user_role()	0	3	1
A	manager()	0	3	1
A	isDemoManager()	0	4	1
A	applicant()	0	3	1
A	isGovIdentityConfirmed()	0	3	2
A	isUpgradedManager()	0	3	2

<?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 $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\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;

The trait Illuminate\Notifications\Notifiable requires the property $phone_number which is not provided by App\Models\User.

    // Trait for Backpack.
    use CrudTrait;

    protected $casts = [

Property \App\Models\User::$casts does not have @var annotation.

Missing member variable doc comment

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

    protected $fillable = [

Property \App\Models\User::$fillable does not have @var annotation.

Missing member variable doc comment

        'name', 'email', 'password', 'is_priority', 'gov_email', 'not_in_gov'
    ];

    protected $with = ['user_role'];

Property \App\Models\User::$with does not have @var annotation.

Missing member variable doc comment

    protected $hidden = [

Property \App\Models\User::$hidden does not have @var annotation.

Missing member variable doc comment

        'password', 'remember_token',
    ];

    /**
     * The event map for the model.
     *
     * @var array

@var annotation of property \App\Models\User::$dispatchesEvents does not specify type hint for its items.

     */
    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 profile_pic() //phpcs:ignore
    {
        return $this->hasOne(\App\Models\ProfilePic::class);
    }

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

    // 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 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' or 'admin'.
    * @return boolean
    */
    public function hasRole($role)

Method \App\Models\User::hasRole() does not have parameter type hint for its parameter $role but it should be possible to add it based on @param annotation "string".

Method \App\Models\User::hasRole() does not have return type hint for its return value but it should be possible to add it based on @return annotation "boolean".

Type hint "string" missing for $role

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

    /**
     * Set this user to the specified role.
     *
     * @param string $role Must be either 'applicant', 'manager' 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

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     *
     * @return void
     */
    public function sendPasswordResetNotification($token)

Method \App\Models\User::sendPasswordResetNotification() does not have parameter type hint for its parameter $token but it should be possible to add it based on @param annotation "string".

Method \App\Models\User::sendPasswordResetNotification() does not have return type hint for its return value but it should be possible to add it based on @return annotation "void".

Type hint "string" missing for $token

    {
        $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.
     *
     * @param [type] $user

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

Missing parameter comment

Superfluous parameter comment

     * @return boolean
     */
    public function isGovIdentityConfirmed()

Method \App\Models\User::isGovIdentityConfirmed() does not have return type hint for its return value but it should be possible to add it based on @return annotation "boolean".

    {
        return $this->not_in_gov || !empty($this->gov_email);
    }
}