osb/app/Models/User.php

288 lines
5.5 KiB
PHP
Raw Normal View History

2017-11-03 05:26:07 +00:00
<?php
2021-06-29 03:18:52 +00:00
namespace App\Models;
2017-11-03 05:26:07 +00:00
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Support\Facades\Log;
2018-07-13 04:53:44 +00:00
use Laravel\Passport\HasApiTokens;
use Leenooks\Traits\ScopeActive;
2018-07-13 04:53:44 +00:00
use Leenooks\Traits\UserSwitch;
2017-11-03 05:26:07 +00:00
use App\Interfaces\IDs;
2020-07-21 06:39:23 +00:00
use App\Notifications\ResetPassword as ResetPasswordNotification;
2024-07-23 05:05:56 +00:00
use App\Traits\SiteID;
/**
* Class User
*
* Attributes for users:
* + role : User's role
*/
class User extends Authenticatable implements IDs
2017-11-03 05:26:07 +00:00
{
2024-07-23 05:05:56 +00:00
use HasFactory,HasApiTokens,Notifiable,UserSwitch,ScopeActive,SiteID;
private const CACHE_TIME = 3600;
2020-02-10 11:07:46 +00:00
2024-07-05 12:56:02 +00:00
protected $casts = [
'last_access' => 'datetime:Y-m-d H:i:s',
'passkey' => 'json',
2020-02-08 11:51:50 +00:00
];
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name',
'email',
'password',
2020-02-08 11:51:50 +00:00
];
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [
'password',
'remember_token',
];
2020-04-18 22:33:41 +00:00
/**
* Role hierarchy order
*
2020-04-18 22:33:41 +00:00
* @var array
*/
public const role_order = [
2020-04-18 22:33:41 +00:00
'wholesaler',
'reseller',
'customer',
];
/* OVERRIDES */
/**
* Users password reset email notification
*
* @param string $token
*/
public function sendPasswordResetNotification($token)
{
2024-08-03 00:47:08 +00:00
$this->notify((new ResetPasswordNotification($token))
->onQueue('user'));
}
/* INTERFACES */
public function getLIDAttribute(): string
{
return sprintf('#%04s',$this->id);
}
public function getSIDAttribute(): string
{
return sprintf('%02s-%s',$this->site_id,$this->getLIDAttribute());
}
/* RELATIONS */
2020-02-08 11:51:50 +00:00
/**
2024-07-05 12:56:02 +00:00
* This user's accounts
2020-02-08 11:51:50 +00:00
*/
2018-07-17 04:10:40 +00:00
public function accounts()
2020-02-08 11:51:50 +00:00
{
return $this->hasMany(Account::class)
->active();
2020-02-08 11:51:50 +00:00
}
2018-05-20 12:53:14 +00:00
2020-02-08 11:51:50 +00:00
/**
2024-07-05 12:56:02 +00:00
* The accounts that this user manages
2020-02-08 11:51:50 +00:00
*
2024-07-05 12:56:02 +00:00
* @return \Illuminate\Database\Eloquent\Relations\HasMany
* @note This cannot be preloaded with load() or with() - $this is a blank object
2020-02-08 11:51:50 +00:00
*/
2024-07-05 12:56:02 +00:00
public function accounts_all()
{
2024-07-05 12:56:02 +00:00
return $this->hasMany(Account::class)
->when((! is_null($this->rtm) && $this->id),
fn($query)=>$query->orWhereIn('rtm_id',$this->rtm?->children_all()->pluck('id')))
->active();
2018-07-13 04:53:44 +00:00
}
2020-02-08 11:51:50 +00:00
/**
* This users language configuration
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
2018-08-01 07:09:38 +00:00
public function language()
{
2021-06-29 03:18:52 +00:00
return $this->belongsTo(Language::class);
2018-08-01 07:09:38 +00:00
}
/**
* Return the routes to market account for this user
*/
public function rtm()
{
return $this->hasOneThrough(Rtm::class,Account::class);
}
/* ATTRIBUTES */
2018-07-13 04:53:44 +00:00
/**
* Logged in user's full name
*
* @return string
* @deprecated use getNameFullAttribute()
*/
public function getFullNameAttribute(): string
{
Log::alert('UMO:! Deprecated function getFullNameAttribute()');
return $this->getNameFullAttribute();
}
2020-02-08 11:51:50 +00:00
/**
* This is an alias method, as it is used by the framework
2020-02-08 11:51:50 +00:00
*
* @return string
2020-02-08 11:51:50 +00:00
*/
public function getNameAttribute(): string
2018-08-08 23:33:51 +00:00
{
return $this->name_full;
2018-08-08 23:33:51 +00:00
}
2018-07-06 06:57:49 +00:00
/**
2024-07-05 12:56:02 +00:00
* Logged in user's full name
2018-07-06 06:57:49 +00:00
*
* @return string
*/
public function getNameFullAttribute(): string
2018-07-06 06:57:49 +00:00
{
return sprintf('%s %s',$this->firstname,$this->lastname);
}
/**
* Return the name, surname first
*
* @return string
*/
public function getNameSurFirstAttribute()
{
return sprintf('%s, %s',$this->lastname,$this->firstname);
}
/**
* Return a friendly string of this persons role
2024-07-05 12:56:02 +00:00
*
* @return string
*/
public function getRoleAttribute(): string
{
return ucfirst($this->role());
}
/**
* Return the name, surname first
* @return string
* @deprecated use getNameSurFirstAttribute()
*/
2018-08-09 14:10:51 +00:00
public function getSurFirstNameAttribute()
2018-08-08 23:33:51 +00:00
{
Log::alert('UMO:! Deprecated function getSurFirstNameAttribute()');
return $this->getNameSurFirstAttribute();
2018-08-08 23:33:51 +00:00
}
/* SCOPES */
2018-08-09 14:10:51 +00:00
/**
* Search for a record
*
2020-02-08 11:51:50 +00:00
* @param $query
* @param string $term
*/
public function scopeSearch($query,string $term)
{
// Build our where clause
// First Name, Last name
if (preg_match('/\s+/',$term)) {
2020-04-14 07:40:47 +00:00
[$fn,$ln] = explode(' ',$term,2);
$query->where(function($query1) use ($fn,$ln,$term) {
$query1->where(function($query2) use ($fn,$ln) {
return $query2
->where('firstname','ilike','%'.$fn.'%')
->where('lastname','ilike','%'.$ln.'%');
});
});
} elseif (is_numeric($term)) {
2022-08-07 02:17:20 +00:00
$query->where('users.id','like','%'.$term.'%');
} elseif (preg_match('/@/',$term)) {
$query->where('email','ilike','%'.$term.'%');
} else {
$query
->Where('firstname','ilike','%'.$term.'%')
->orWhere('lastname','ilike','%'.$term.'%');
}
return $query;
}
/* METHODS */
/**
* Determine if the user is an admin of the user with $id
*
* @param User|null $user
* @return bool
*/
public function isAdmin(User $user=NULL): bool
{
2024-07-05 12:56:02 +00:00
return $user->exists
&& $this->isReseller()
&& $this->accounts_all
->pluck('user_id')
->contains($user->id);
}
2018-08-09 14:10:51 +00:00
/**
* Determine if the logged in user is a reseller or wholesaler
*
* @return bool
*/
2020-02-08 11:51:50 +00:00
public function isReseller(): bool
2018-08-09 14:10:51 +00:00
{
return in_array($this->role(),['wholesaler','reseller']);
}
2020-02-08 11:51:50 +00:00
/**
* Determine if the logged in user is a wholesaler
*
* @return bool
*/
public function isWholesaler(): bool
2018-08-23 05:17:26 +00:00
{
return in_array($this->role(),['wholesaler']);
}
/**
* Determine what the logged in user's role is
* + Wholesaler - aka Super User
* + Reseller - services accounts on behalf of their customers
* + Customer - end user customer
*
* @return string
*/
2018-07-06 06:57:49 +00:00
public function role()
{
2024-07-05 12:56:02 +00:00
return $this->rtm
? ($this->rtm->parent_id ? 'reseller' : 'wholesaler')
: 'customer';
2018-07-06 06:57:49 +00:00
}
}