App\Models\User

Complexity

Total Complexity

11

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Test Coverage

Coverage

30%

Importance

Changes

0

7 Methods

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

<?php

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

Missing @link tag in file comment

Missing @category tag in file comment

Missing @author tag in file comment

PHP version not specified

Missing @package tag in file comment

Missing @license tag in file comment

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;

/**
 * Class User
 *
 * @property int $id
 * @property string $email
 * @property string $name
 * @property string $password
 * @property bool $is_confirmed
 * @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
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

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
        {

Expected 0 spaces before opening brace; 8 found

    //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.

    protected $casts = [
        'is_confirmed' => 'bool',
        'user_role_id' => 'int'
    ];
    protected $fillable = [
        'name', 'email', 'password',
    ];
    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() {

Missing doc comment for function applicant()

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

    public function manager() {

Missing doc comment for function manager()

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

    public function profile_pic() {

Public method name "User::profile_pic" is not in camel caps format

Missing doc comment for function profile_pic()

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

    public function user_role() {

Public method name "User::user_role" is not in camel caps format

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

Expected 5 space(s) before asterisk; 4 found

    * @param string|array $roles

Expected 5 space(s) before asterisk; 4 found

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

    */

Expected 5 space(s) before asterisk; 4 found

Missing @return tag in function comment

    public function authorizeRoles($roles)
    {
      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

Expected 5 space(s) before asterisk; 4 found

    * @param array $roles

Expected 5 space(s) before asterisk; 4 found

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

    */

Expected 5 space(s) before asterisk; 4 found

Missing @return tag in function comment

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

    /**
    * Check one role

Expected 5 space(s) before asterisk; 4 found

    * @param string $role

Expected 5 space(s) before asterisk; 4 found

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

    */

Expected 5 space(s) before asterisk; 4 found

Missing @return tag in function comment

    public function hasRole($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

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function sendPasswordResetNotification($token)
    {
        $this->notify(new ResetPasswordNotification($token));
    }

}