App\Device

Complexity

Total Complexity

43

Size/Duplication

Total Lines	441
Duplicated Lines	20.41 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	location()	0	3	1
A	getSiteAttribute()	0	3	1
A	getCloseTimeAttribute()	10	10	2
A	getCreatedAtHumanAttribute()	6	6	2
A	setCloseTimeAttribute()	12	12	2
A	getLastNetworkUpdateAtHumanAttribute()	6	6	2
A	getOpenTimeHumanAttribute()	6	6	1
A	getCloseTimeHumanAttribute()	6	6	1
A	setOpenTimeAttribute()	12	12	2
A	getUpdatedAtHumanAttribute()	6	6	2
A	getOpenTimeAttribute()	10	10	2
A	scopePublicDashData()	0	15	1
A	generateToken()	0	6	1
A	isReadyForCommand()	0	3	3
A	getDeviceByUUID()	0	3	1
A	scopeByLocation()	0	3	1
A	image()	0	3	1
A	data()	0	3	1
A	getDeletedAtHumanAttribute()	6	6	2
A	isDuringScheduleOpen()	0	13	3
A	sensors()	0	3	1
A	dashPageNum()	0	8	1
D	actualCoverStatus()	0	38	9

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Carbon\Carbon;
use Illuminate\Support\Facades\Auth;
use Spatie\Activitylog\Traits\LogsActivity;

class Device extends Model
{
    use SoftDeletes;
    use LogsActivity;
    //use CausesActivity;
    
    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'deleted_at',
        'last_network_update_at'
    ];
    
    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [ 'token' ];
    
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'location_id', 'uuid', 'version', 'hostname', 'ip', 'mac_address', 
        'time', 'cover_command', 'cover_status', 'error_msg', 'update_rate',
        'image_rate', 'sensor_rate', 'open_time', 'close_time', 'last_network_update_at',
    ];
    
    /**
     * The attributes to ignore in the Activity Log
     *
     * @var array
     */
    protected static $ignoreChangedAttributes = [ 'updated_at', 'last_network_update_at' ];
    
    /**
     * The attributes to log in the Activity Log
     *
     * @var array
     */
    protected static $logAttributes = [
        'name', 'location_id', 'uuid', 'version', 'hostname', 'ip', 'mac_address', 
        'time', 'cover_command', 'cover_status', 'error_msg',
        'update_rate', 'image_rate', 'sensor_rate', 'open_time', 'close_time'
    ];
    
    /**
     * Only log those that have actually changed after the update.
     *
     * @var array
     */
    protected static $logOnlyDirty = true;
    
    /**
     * Update the updated_at and created_at timestamps?
     *
     * @var array
     */
    public $timestamps = true;
    
    /**
     * Get the location for the device
     */
    public function location()
    {
        return $this->belongsTo('App\Location', 'location_id');
    }
    
    /**
     * Get the site for the device using model accessor
     */
    public function getSiteAttribute()
    {
        return $this->location->site ?? (object) [ ];
    }
    
    /**
     * Accessor: Get the open time of the device converted to hours and minutes
     * If it is a device accessing the time use UTC
     * If it is a user accessing the time use their preferred timezone
     *
     * @param  string $value
     * @return string
     */
    public function getOpenTimeAttribute($value)
    {
        $time = new Carbon($value, 'UTC');
        
        //If the user is logged in then use there preferred timezone
        if (Auth::check()) {
                    $time = $time->setTimezone(Auth::user()->timezone);
        }

        return $time->format('H:i');
    }
    
    /**
     * Accessor: Get the open time of the device converted to the users preferred time and
     * converted to a user friendly format of h:i a
     *
     * @return string
     */
    public function getOpenTimeHumanAttribute()
    {
        $time = new Carbon($this->attributes[ 'open_time' ], 'UTC');
        $time = $time->setTimezone(Auth::user()->timezone);
        
        return $time->format('h:i a');
    }
    
    /**
     * Accessor: Get the close time of the device converted to hours and minutes
     * If it is a device accessing the time use UTC
     * If it is a user accessing the time use their preferred timezone
     *
     * @param  string $value
     * @return string
     */
    public function getCloseTimeAttribute($value)
    {
        $time = new Carbon($value, 'UTC');
    
        //If the user is logged in then use there preferred timezone
        if (Auth::check()) {
                    $time = $time->setTimezone(Auth::user()->timezone);
        }
        
        return $time->format('H:i');
    }
    
    /**
     * Accessor: Get the close time of the device converted to the users preferred time and
     * converted to a user friendly format of h:i a
     *
     * @return string
     */
    public function getCloseTimeHumanAttribute()
    {
        $time = new Carbon($this->attributes[ 'close_time' ], 'UTC');
        $time = $time->setTimezone(Auth::user()->timezone);
        
        return $time->format('h:i a');
    }
    
    /**
     * Set the open time to UTC
     * If it is a device saving the time use UTC
     * If it is a user saving the time use their preferred timezone
     *
     * @param  string  $value
     * @return void
     */
    public function setOpenTimeAttribute($value)
    {
        //If the user is logged in then use there preferred timezone
        if (Auth::check())
        {
            $time = new Carbon($value, Auth::user()->timezone);
            $time = $time->setTimezone('UTC');
        } else {
                    $time = new Carbon($value, 'UTC');
        }
        
        $this->attributes[ 'open_time' ] = $time->format('H:i:s');
    }
    
    /**
     * Set the close time to UTC
     * If it is a device saving the time use UTC
     * If it is a user saving the time use their preferred timezone
     *
     * @param  string  $value
     * @return void
     */
    public function setCloseTimeAttribute($value)
    {
        //If the user is logged in then use there preferred timezone
        if (Auth::check())
        {
            $time = new Carbon($value, Auth::user()->timezone);
            $time = $time->setTimezone('UTC');
        } else {
                    $time = new Carbon($value, 'UTC');
        }
        
        $this->attributes[ 'close_time' ] = $time->format('H:i:s');
    }
    
    /**
     * Accessor: Get the last time the server received an update call from the device in seconds/minutes/hours since
     * update or converted to user friendly readable format.
     * If the time is less then a day old then display time since it last updated
     * If the time is greater then a day old then display the time in the format of Month day, year 12hour:mins am/pm
     * and using the user's preferred timezone
     *
     * @return string
     */
    public function getLastNetworkUpdateAtHumanAttribute()
    {
        if ($this->last_network_update_at->diffInDays() > 0) {
                    return $this->last_network_update_at->setTimezone(Auth::user()->timezone)->format('M d, Y h:i a');
        } else {
                    return $this->last_network_update_at->diffForHumans();
        }
    }
    
    /**
     * Accessor: Get the devices last update time in seconds/minutes/hours since update or converted to user friendly
     * readable format.
     * If the time is less then a day old then display time since it last update
     * If the time is greater then a day old then display the time in the format of Month day, year 12hour:mins am/pm
     * and using the user's preferred timezone
     *
     *
     * @return string
     */
    public function getUpdatedAtHumanAttribute()
    {
        if ($this->updated_at->diffInDays() > 0) {
                    return $this->updated_at->setTimezone(Auth::user()->timezone)->format('M d, Y h:i a');
        } else {
                    return $this->updated_at->diffForHumans();
        }
    }
    
    /**
     * Accessor: Get the devices creation time in seconds/minutes/hours since creation or converted to user friendly
     * readable format.
     * If the time is less then a day old then display time since its creation
     * If the time is greater then a day old then display the time in the format of Month day, year 12hour:mins am/pm
     * and using the user's preferred timezone
     *
     * @return string
     */
    public function getCreatedAtHumanAttribute()
    {
        if ($this->created_at->diffInDays() > 0) {
                    return $this->created_at->setTimezone(Auth::user()->timezone)->format('M d, Y h:i a');
        } else {
                    return $this->created_at->diffForHumans();
        }
    }
    
    /**
     * Accessor: Get the devices deletion time in seconds/minutes/hours since creation or converted to user friendly
     * readable format.
     * If the time is less then a day old then display time since its deletion
     * If the time is greater then a day old then display the time in the format of Month day, year 12hour:mins am/pm
     * and using the user's preferred timezone
     *
     * @return string
     */
    public function getDeletedAtHumanAttribute()
    {
        if ($this->deleted_at->diffInDays() > 0) {
            return $this->deleted_at->setTimezone(Auth::user()->timezone)->format('M d, Y h:i a');
        } else {
            return $this->deleted_at->diffForHumans();
        }
    }
    
    /**
     * Scope a query to only include devices belonging to a given location
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param int $location_id
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeByLocation($query, $location_id)
    {
        return $query->where('location_id', $location_id);
    }
    
    /**
     * Scope a query to limit the included columns to only include what is publicly needed to be displayed on the
     * dashboard
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePublicDashData($query)
    {
        return $query->select([

The expression return $query->select(array('devices.id', 'name', 'location_id', 'cover_command', 'cover_status', 'open_time', 'close_time', 'update_rate', 'image_rate', 'sensor_rate', 'last_network_update_at', 'image.updated_at as image_updated_at')) also could return the type Illuminate\Database\Query\Builder which is incompatible with the documented return type Illuminate\Database\Eloquent\Builder.

            'devices.id',
            'name',
            'location_id',
            'cover_command',
            'cover_status',
            'open_time',
            'close_time',
            'update_rate',
            'image_rate',
            'sensor_rate',
            'last_network_update_at',
            'image.updated_at as image_updated_at',
        ]);
    }
    
    /**
     * Create a new API token for the device.
     */
    public function generateToken()
    {
        $this->token = str_random(60);
        $this->save();
        
        return $this->token;
    }
    
    /**
     * Get a device by uuid
     *
     * @param string $uuid
     * @return Device|Illuminate\Database\Eloquent\Model

The type App\Illuminate\Database\Eloquent\Model was not found. Did you mean Illuminate\Database\Eloquent\Model? If so, make sure to prefix the type with \.

     */
    public static function getDeviceByUUID($uuid)
    {
        return self::where('uuid', $uuid)->first();
    }
    
    /**
     * Get the deviceimage record associated with the device.
     */
    public function image()
    {
        return $this->hasOne('App\Deviceimage');
    }
    

    /**
     * Get the sensors associated with the device.
     */
    public function sensors()
    {
        return $this->hasMany('App\Sensor');
    }
    
    /**
     * Get the sensor data associated with the device.
     */
    public function data()
    {
        return $this->hasManyThrough('App\SensorData', 'App\Sensor');
    }
    
    /**
     * Check if the device is ready for a cover command
     *
     * @return boolean
     */
    public function isReadyForCommand()
    {
        return ($this->cover_status == 'open' || $this->cover_status == 'closed' || $this->cover_status == 'locked');
    }
    
    /**
     * Check if the current time is during the devices scheduled time to be open
     *
     * @return boolean
     */
    public function isDuringScheduleOpen()
    {
        $timezone = Auth::user()->timezone;
        //Get the open, close, and current time in the users timezone
        $open_time = new Carbon($this->open_time, $timezone);
        $close_time = new Carbon($this->close_time, $timezone);
        $time_now = Carbon::now($timezone);
    
        //Check if the current time is during the open schedule or not
        if ($time_now->gt($open_time) && $time_now->lt($close_time)) {
                    return true;
        } else {
                    return false;
        }
    }
    
    /**
     * Get the covers actual status based on the current command and the devices status
     *
     * @return string
     */
    public function actualCoverStatus()
    {
        $isOpen = $this->cover_status === 'open';
        $isClosed = $this->cover_status === 'closed';
        $isLocked = $this->cover_status === 'locked';
            
        switch ($this[ 'cover_command' ])
        {
            case 'open':
                if ($isOpen) {
                                    $status = 'open';
                } else if ($isLocked) {
                                    $status = 'unlocking';
                } else {
                                    $status = 'opening';
                }
                break;
            case 'close':
                if ($isClosed) {
                                    $status = 'closed';
                } else if ($isLocked) {
                                    $status = 'unlocking';
                } else {
                                    $status = 'closing';
                }
                break;
            case 'lock':
                $status = 'locked';
                break;
            default:
                $status = 'error';
        }
    
        if ($this->cover_status === 'error') {
                    $status = 'error';
        }
        
        return $status;
    }
    
    /**
     * Get the page number of the device for the dashboard device table pagination
     *
     * @param int $limit
     * @return double
     */
    public function dashPageNum($limit)
    {
        $pos = Device::where('location_id', '=', $this->location_id)
            ->where('name', '<=', $this->name)
            ->orderBy('name', 'ASC')
            ->count();
        
        return ceil($pos / $limit);
    }
}