Sfneal\Users\Models\User

Complexity

Total Complexity

51

Size/Duplication

Total Lines	466
Duplicated Lines	0 %

Importance

Changes	16
Bugs	2	Features	0

37 Methods

Rating	Name	Duplication	Size	Complexity
A	boot()	0	7	1
A	getRateFormattedAttribute()	0	3	2
A	isEmployee()	0	3	1
A	getListNameAttribute()	0	3	1
A	getPhoneWorkLinkAttribute()	0	3	2
A	getTextareaAttribute()	0	3	1
A	notificationSubscriptions()	0	3	1
A	getPhoneMobileLinkAttribute()	0	3	2
A	getNameFullAttribute()	0	8	2
A	newEloquentBuilder()	0	3	1
A	getCityAttribute()	0	3	1
A	isNicknamePreferred()	0	3	1
A	setMiddleNameAttribute()	0	8	3
A	getAddress1Attribute()	0	3	1
A	getInitialsAttribute()	0	9	1
A	getCityStateAttribute()	0	3	1
A	isAdmin()	0	4	2
A	getNameSuffixAttribute()	0	3	2
A	getNameAttribute()	0	7	3
A	getEmailLinkAttribute()	0	3	2
A	getEmailFooterAttribute()	0	9	3
A	role()	0	3	1
A	team()	0	3	1
A	isRoleId()	0	3	1
A	query()	0	3	1
A	getUploadDirectory()	0	3	1
A	setPasswordAttribute()	0	4	2
A	getStateAttribute()	0	3	1
A	isWebDeveloper()	0	3	1
A	getZipAttribute()	0	3	1
A	getNameLinkAttribute()	0	3	1
A	address()	0	3	1
A	getAddress2Attribute()	0	3	1
A	isActive()	0	3	1
A	isContractor()	0	3	1
A	isRole()	0	3	1
A	newFactory()	0	3	1

<?php

namespace Sfneal\Users\Models;

use Database\Factories\UserFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\MorphOne;
use Sfneal\Address\Models\Address;
use Sfneal\Casts\NewlineCast;
use Sfneal\Currency\Currency;
use Sfneal\Models\AuthModel;
use Sfneal\Scopes\OrderScope;
use Sfneal\Users\Builders\UserBuilder;
use Sfneal\Users\Scopes\UserActiveScope;
use Sfneal\Users\Services\OrganizationService;
use Vkovic\LaravelCustomCasts\HasCustomCasts;

class User extends AuthModel
{
    // todo: refactor status to use Status model?
    use HasCustomCasts;
    use HasFactory;

    /**
     * The "booting" method of the model.
     *
     * @return void
     */
    public static function boot()
    {
        parent::boot();

        // Global scopes
        static::addGlobalScope(new UserActiveScope());
        static::addGlobalScope(new OrderScope('last_name', 'asc'));
    }

    protected $dates = ['deleted_at'];
    protected $table = 'user';
    protected $primaryKey = 'id';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'role_id',
        'first_name',
        'middle_name',
        'last_name',
        'nickname',
        'nickname_preferred',
        'title',
        'suffix',
        'email',
        'phone_work',
        'phone_mobile',
        'fax',
        'website',
        'bio',
        'username',
        'password',
        'status',
        'rate',
    ];

    /**
     * The attributes that should be hidden from arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * The attributes that should type cast.
     *
     * @var array
     */
    protected $casts = [
        'role_id' => 'int',
        'nickname_preferred' => 'int',
        'bio' => NewlineCast::class,
        'status' => 'int',
        'rate' => 'int',
    ];

    /**
     * Create a new factory instance for the model.
     *
     * @return UserFactory
     */
    protected static function newFactory(): UserFactory
    {
        return new UserFactory();
    }

    /**
     * Query Builder.
     * @param $query
     * @return UserBuilder
     */
    public function newEloquentBuilder($query)
    {
        return new UserBuilder($query);
    }

    /**
     * Custom User query Builder.
     *
     * @return UserBuilder|Builder
     */
    public static function query(): UserBuilder
    {
        return parent::query();
    }

    /**
     * User's 'role' relationship.
     *
     * @return BelongsTo
     */
    public function role()
    {
        return $this->belongsTo(Role::class, 'role_id', 'role_id');
    }

    /**
     * User's Notification Subscriptions.
     *
     * @return HasMany
     */
    public function notificationSubscriptions()
    {
        return $this->hasMany(UserNotification::class, 'user_id', 'id');
    }

    /**
     * User's 'team' relationship - indicates user is a member of the public team.
     *
     * @return HasOne
     */
    public function team()
    {
        return $this->hasOne(Team::class, 'user_id', 'id');
    }

    /**
     * User's address.
     *
     * @return MorphOne|Address
     */
    public function address()
    {
        return $this->morphOne(Address::class, 'addressable');
    }

    /**
     * Determine if a User has a particular 'role_id'.
     *
     * @param int $role_id
     * @return bool
     */
    public function isRoleId(int $role_id): bool
    {
        return $this->role_id == $role_id;

The property role_id does not exist on Sfneal\Users\Models\User. Did you mean role?

    }

    /**
     * Determine if a User has a particular 'role name'.
     *
     * @param string $role
     * @return bool
     */
    public function isRole(string $role): bool
    {
        return strtolower($this->role->name) == strtolower($role);

The property name does not seem to exist on Sfneal\Users\Models\Role. Are you sure there is no database migration missing?

    }

    /**
     * Determine if a User has an 'admin' role.
     *
     * @return bool
     */
    public function isAdmin(): bool
    {
        // User is considered an 'admin' if user is a 'web developer'
        return $this->isRoleId(3) || $this->isRoleId(4);
    }

    /**
     * Determine if a User has a 'web developer' role.
     *
     * @return bool
     */
    public function isWebDeveloper(): bool
    {
        return $this->isRoleId(4);
    }

    /**
     * Determine if a User has an 'employee' role.
     *
     * @return bool
     */
    public function isEmployee(): bool
    {
        return $this->isRoleId(1);
    }

    /**
     * Determine if a User has an 'contractor' role.
     *
     * @return bool
     */
    public function isContractor(): bool
    {
        return $this->isRoleId(2);
    }

    /**
     * Determine if a User is 'active'.
     *
     * @return bool
     */
    public function isActive(): bool
    {
        return $this->status == 1;

The property status does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Determine if a User's $nickname is preferred over their $first_name.
     *
     * @return bool
     */
    public function isNicknamePreferred(): bool
    {
        return $this->nickname_preferred == 1;

The property nickname_preferred does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve a User's initials.
     *
     * @return string
     */
    public function getInitialsAttribute()
    {
        return implodeFiltered('', collect([
            $this->first_name,

The property first_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

            $this->middle_name,

The property middle_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

            $this->last_name,

The property last_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        ])->map(function ($name) {
            return substr($name, 0, 1);
        })->toArray());
    }

    /**
     * Get the AWS S3 file upload directory for an Inquiry model by retrieving the table name and primary key.
     *
     * @param string $base_dir
     * @return string
     */
    public function getUploadDirectory($base_dir = 'images'): string
    {
        return $base_dir.'/'.str_replace('_', '-', $this->getTable()).'/'.$this->getKey();
    }

    /**
     * Get the 'city_state' attribute.
     *
     * @return string
     */
    public function getCityStateAttribute()
    {
        return $this->address->city_state ?? null;
    }

    /**
     * Set the 'password' attribute.
     *
     * @param $value
     */
    public function setPasswordAttribute($value)
    {
        if (! empty($value)) {
            $this->attributes['password'] = bcrypt($value);
        }
    }

    /**
     * Mutate the 'middle_name' attribute.
     *
     * @param string|null $value
     */
    public function setMiddleNameAttribute(string $value = null)
    {
        if (! is_null($value)) {
            // Remove leading & trailing whitespace
            $middle_name = trim($value);

            // Append '.' to the middle name if's a single letter
            $this->attributes['middle_name'] = strlen($middle_name) == 1 ? "{$middle_name}." : $middle_name;
        }
    }

    /**
     * Retrieve the User's name (first & last).
     *
     * @return string
     */
    public function getNameAttribute(): string
    {
        // Use nickname instead of first if it is set & preferred
        $first = (isset($this->nickname) && $this->isNicknamePreferred()) ? $this->nickname : $this->first_name;

The property first_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

The property nickname does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        // Return concatenated name
        return "{$first} {$this->last_name}";

The property last_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the User's full name with middle initial.
     *
     * @return string
     */
    public function getNameFullAttribute(): string
    {
        $name = $this->first_name;

The property first_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        if ($this->middle_name) {

The property middle_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

            $name .= ' '.$this->middle_name;
        }

        return "{$name} {$this->last_name}";

The property last_name does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the User's name with their suffix.
     *
     * @return string
     */
    public function getNameSuffixAttribute(): string
    {
        return $this->name_full.($this->suffix ? ", {$this->suffix}" : '');

The property suffix does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Get the 'list_name' attribute.
     *
     * @return string
     */
    public function getListNameAttribute()
    {
        return implode(', ', array_reverse(explode(' ', $this->name)));
    }

    /**
     * Get the 'name_link' attribute that returns a url to the User's team.show page.
     *
     * @return string
     */
    public function getNameLinkAttribute()
    {
        return '<a href="'.route('user.show', ['user'=>$this->id]).'">'.$this->name.'</a>';
    }

    // todo: add address accessor method to a sfneal/address trait

    /**
     * Retrieve the User's 'address1' attribute.
     *
     * @return mixed
     */
    public function getAddress1Attribute()
    {
        return $this->address->address_1 ?? null;

The property address_1 does not exist on Sfneal\Address\Models\Address. Did you mean addressable?

    }

    /**
     * Retrieve the User's 'address2' attribute.
     *
     * @return mixed
     */
    public function getAddress2Attribute()
    {
        return $this->address->address_2 ?? null;

The property address_2 does not exist on Sfneal\Address\Models\Address. Did you mean addressable?

    }

    /**
     * Retrieve the User's 'city' attribute.
     *
     * @return mixed
     */
    public function getCityAttribute()
    {
        return $this->address->city ?? null;

The property city does not seem to exist on Sfneal\Address\Models\Address. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the User's 'state' attribute.
     *
     * @return mixed
     */
    public function getStateAttribute()
    {
        return $this->address->state ?? null;

The property state does not seem to exist on Sfneal\Address\Models\Address. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the User's 'zip' attribute.
     *
     * @return mixed
     */
    public function getZipAttribute()
    {
        return $this->address->zip ?? null;

The property zip does not seem to exist on Sfneal\Address\Models\Address. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve an email link.
     *
     * @return string
     */
    public function getEmailLinkAttribute(): string
    {
        return $this->email ? ('mailto:'.$this->email) : '#!';

The property email does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve a work phone link.
     *
     * @return string
     */
    public function getPhoneWorkLinkAttribute(): string
    {
        return $this->phone_work ? ('tel:'.$this->phone_work) : '#!';

The property phone_work does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve a mobile phone link.
     *
     * @return string
     */
    public function getPhoneMobileLinkAttribute(): string
    {
        return $this->phone_mobile ? ('tel:'.$this->phone_mobile) : '#!';

The property phone_mobile does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the User's rate formatted as dollars.
     *
     * @return string
     */
    public function getRateFormattedAttribute(): string
    {
        return (! empty($this->rate)) ? Currency::dollars($this->rate) : '-';

The property rate does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

    }

    /**
     * Retrieve the raw 'text' attribute with newline chars.
     *
     * @return mixed
     */
    public function getTextareaAttribute()
    {
        return $this->attributes['bio'];
    }

    /**
     * Retrieve a User's custom email footer.
     *
     * @return string
     */
    public function getEmailFooterAttribute(): string
    {
        $footer = "{$this->name}";
        $footer .= $this->title ? "\n{$this->title}" : '';

The property title does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        $footer .= "\n".OrganizationService::name() ?? '';
        $footer .= "\n".($this->phone_work ?? OrganizationService::phone()) ?? '';

The property phone_work does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        $footer .= $this->email ? "\n{$this->email}" : '';

The property email does not seem to exist on Sfneal\Users\Models\User. Are you sure there is no database migration missing?

        return $footer;
    }
}