SET\User

Complexity

Total Complexity

37

Size/Duplication

Total Lines	236
Duplicated Lines	3.39 %

Coupling/Cohesion

Components	3
Dependencies	5

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	supervisor()	0	4	1
A	subordinates()	0	4	1
A	attachments()	0	4	1
A	notes()	0	4	1
A	travels()	0	4	1
A	visits()	0	4	1
A	assignedTrainings()	0	4	1
A	trainingUsers()	0	4	1
A	trainings()	0	4	1
A	groups()	0	4	1
A	duties()	0	4	1
A	dutySwap()	0	4	1
A	news()	0	4	1
A	getUserFullNameAttribute()	0	14	3
A	scopeSearchUsers()	0	6	1
A	scopeActive()	0	4	1
A	scopeSkipSystem()	0	4	1
A	setAttribute()	8	8	3
C	getUserLog()	0	27	7
B	arrayRecursiveDiff()	0	20	8

<?php

namespace SET;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

use Spatie\Activitylog\Models\Activity;
use Spatie\Activitylog\Traits\LogsActivity;

/**
 * Class User.
 */
class User extends Authenticatable
{
    use Notifiable;

    /**
     * @var string
     */
    protected $table = 'users';
    /**
     * @var bool
     */
    public $timestamps = true;
    /**
     * @var array
     */
    protected $fillable = ['username', 'emp_num', 'first_name', 'nickname', 'last_name',
        'email', 'phone', 'status', 'clearance', 'elig_date', 'inv', 'inv_close', 'destroyed_date',
        'supervisor_id', 'access_level', 'password', ];
    /**
     * @var array
     */
    protected $hidden = ['username', 'password', 'remember_token'];


    /**
     * @var array $logAttributes defines will log the changed attributes
     */
     use LogsActivity;
     protected static $logAttributes = ['username', 'emp_num', 'first_name', 'nickname',
         'last_name', 'email', 'phone', 'jpas_name', 'status', 'clearance',
         'elig_date', 'inv', 'inv_close', 'destroyed_date', 'role', 'supervisor_id', 'access_level',
         'last_logon', 'ip',];

    /**
     * make destroyed_date a Carbon instance.
     */
    protected $dates = ['destroyed_date'];

    public function supervisor()
    {
        return $this->belongsTo('SET\User', 'supervisor_id');
    }

    public function subordinates()
    {
        return $this->hasMany('SET\User', 'supervisor_id');
    }

    public function attachments()
    {
        return $this->morphMany('SET\Attachment', 'imageable');
    }

    public function notes()
    {
        return $this->hasMany('SET\Note');
    }

    public function travels()
    {
        return $this->hasMany('SET\Travel');
    }

    public function visits()
    {
        return $this->hasMany('SET\Visit');
    }

    public function assignedTrainings()
    {
        return $this->hasMany('SET\TrainingUser', 'user_id');
    }

    public function trainingUsers()
    {
        return $this->hasMany('SET\TrainingUser', 'user_id');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function trainings()
    {
        return $this->belongsToMany('SET\Training');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function groups()
    {
        return $this->belongsToMany('SET\Group')->withPivot('access');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function duties()
    {
        return $this->belongsToMany('SET\Duty');
    }

    public function dutySwap()
    {
        return $this->morphMany('SET\DutySwap', 'imageable');
    }

    public function news()
    {
        return $this->hasMany('SET\News');
    }

    /**
     * If we have a nickname, return 'lastname, nickname' otherwise return 'lastname, firstname'.
     *
     * @return string
     */
    public function getUserFullNameAttribute()
    {
        if ($this->attributes['id'] == 1) {
            $fullName = 'system';
        } elseif ($this->attributes['nickname']) {
            $fullName = $this->attributes['last_name']
                .', '.$this->attributes['first_name']
                .' ('.$this->attributes['nickname'].')';
        } else {
            $fullName = $this->attributes['last_name'].', '.$this->attributes['first_name'];
        }

        return $fullName;
    }

    /**
     * @param $query
     * @param $input
     */
    public function scopeSearchUsers($query, $input)
    {
        return $query->where('first_name', 'LIKE', "%$input%")
            ->orWhere('last_name', 'LIKE', "%$input%")
            ->orWhere('emp_num', 'LIKE', "%$input%");
    }

    /**
     * @param $query
     *
     * @return mixed
     */
    public function scopeActive($query)
    {
        return $query->where('status', 'active');
    }

    public function scopeSkipSystem($query)
    {
        return $query->where('id', '>', 1);
    }

    /**
     * @param string $key
     * @param mixed  $value
     *
     * @return $this
     */
    public function setAttribute($key, $value)
    {
        if (is_scalar($value) && $value === '') {
            $value = null;
        }

        return parent::setAttribute($key, $value);
    }

    /**
     * @param $user
     * Obtain the Activitylog for the designated user or for all users.
     * Populate log array values ["comment", "updated_at", "user_fullname"]
     *
     * @return Log collection
     */
    public function getUserLog($user=NULL) {
      $ignoreList = ['password', 'last_logon', 'remember_token', 'ip'];
      $record = $logs = []; // define arrays

      foreach ( ($user) ? $user->activity : Activity::all() as $entry) {
        $record['updated_at'] = $entry->updated_at;
        $record['user_fullname'] = $entry->properties['attributes']['last_name']
            .', '.$entry->properties['attributes']['first_name'];

        $record['comment'] = '';
        if ($entry->description == 'updated' ) { // Report all changes on each update
          $result=$this->arrayRecursiveDiff( $entry->changes->get('attributes'),
              $entry->changes->get('old') );
          foreach ($result as $key => $value) {
            if (!in_array($key, $ignoreList)) $record['comment'] .=
                ucfirst($key)." ".$entry->description." from '"
                .$entry->changes->get('old')[$key]."' to '". $value ."'.\n";
          }
        } else { // description == 'created' ||  'deleted'
            $record['comment'] .= $entry->description." user '".$record['user_fullname']."'.\n";
        }

        // Append only non-ignored record entries to log
        if ($record['comment']) array_push($logs, $record);
      }
      return collect($logs)->sortByDesc('updated_at');  // return latest -> earliest
    }

    /**
     * @param Array1 Array2
     * As array_diff function only checks one dimension of a n-dimensional array.
     * arrayRecursiveDiff will compare n-dimensional.
     * Will insure compared objects are arrays.
     * @return DiffsArray
     */
    private function arrayRecursiveDiff($aArray1, $aArray2) {
      $aReturn = array();
      if ( !is_array($aArray1) || !is_array($aArray2))  return $aReturn;
      foreach ($aArray1 as $mKey => $mValue) {
          if (array_key_exists($mKey, $aArray2)) {
              if (is_array($mValue)) {
                  $aRecursiveDiff = $this->arrayRecursiveDiff($mValue, $aArray2[$mKey]);
                  if (count($aRecursiveDiff)) { $aReturn[$mKey] = $aRecursiveDiff; }
              } else {
                  if ($mValue != $aArray2[$mKey]) {
                      $aReturn[$mKey] = $mValue;
                  }
              }
          } else {
              $aReturn[$mKey] = $mValue;
          }
      }

      return $aReturn;
  }
}