App\Models\User

Complexity

Total Complexity

11

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Test Coverage

Coverage

40%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	hasAnyRole()	0	3	1
A	hasRole()	0	3	1
A	profile_pic()	0	2	1
A	user_role()	0	2	1
A	manager()	0	2	1
A	applicant()	0	2	1
A	authorizeRoles()	0	8	4

<?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 \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, 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',
    ];
    protected $fillable = [

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

Missing member variable doc comment

        'name', 'email', 'password', 'is_priority'
    ];
    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() {

Method \App\Models\User::applicant() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function applicant()

        return $this->hasOne(\App\Models\Applicant::class);
    }

    public function manager() {

Method \App\Models\User::manager() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function manager()

        return $this->hasOne(\App\Models\Manager::class);
    }

    public function profile_pic() {

Method name "User::profile_pic" is not in camel caps format

Method \App\Models\User::profile_pic() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function profile_pic()

        return $this->hasOne(\App\Models\ProfilePic::class);
    }

    public function user_role() {

Method name "User::user_role" is not in camel caps format

Method \App\Models\User::user_role() does not have return type hint nor @return annotation for its return value.

Missing doc comment for function user_role()

        return $this->belongsTo(\App\Models\UserRole::class);
    }

    //Role related functions

    /**
    * Abort with an HTTP error if user doesn't have correct roles
    * @param string|array $roles

@param annotation of method \App\Models\User::authorizeRoles() does not specify type hint for items of its traversable parameter $roles.

Missing parameter comment

    */

Missing @return tag in function comment

    public function authorizeRoles($roles)

Method \App\Models\User::authorizeRoles() does not have return type hint nor @return annotation for its return value.

    {
      if (is_array($roles)) {
          return $this->hasAnyRole($roles) ||
                 abort(401, 'This action is unauthorized.');

Are you sure the usage of abort(401, 'This action is unauthorized.') is correct as it seems to always return null.

      }
      return $this->hasRole($roles) ||
             abort(401, 'This action is unauthorized.');

Are you sure the usage of abort(401, 'This action is unauthorized.') is correct as it seems to always return null.

    }

    /**
    * Check multiple roles
    * @param array $roles

@param annotation of method \App\Models\User::hasAnyRole() does not specify type hint for items of its traversable parameter $roles.

Missing parameter comment

    */

Missing @return tag in function comment

    public function hasAnyRole($roles)

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

Method \App\Models\User::hasAnyRole() does not have return type hint nor @return annotation for its return value.

Type hint "array" missing for $roles

    {
        return in_array($this->user_role->name, $roles);
        //return null !== $this->roles()->whereIn(‘name’, $roles)->first();
    }

    /**
    * Check one role
    * @param string $role

Missing parameter comment

    */

Missing @return tag in function comment

    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 nor @return annotation for its return value.

Type hint "string" missing for $role

    {
        return $this->user_role->name == $role;
        //return null !== $this->roles()->where(‘name’, $role)->first();
    }

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