User::query() - Code Metrics - Inspection of "Optimize related `Address` model accessors in `Use..." - sfneal/users - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#47)

by Stephen
created 2021-09-02 18:44 UTC
User::query() A

↳ Parent: User
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	1
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?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\Address\Models\Traits\AddressAccessors;
use Sfneal\Casts\NewlineCast;
use Sfneal\Currency\Currency;
use Sfneal\Helpers\Strings\StringHelpers;
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 AddressAccessors;

    use HasCustomCasts;
    use HasFactory;

    /**
     * The "booting" method of the model.
     *
     * @return void
     */
    protected 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',
    ];

    /**
     * @var array Attributes that should be appended to collections
     */
    protected $appends = [
        'name',
    ];

    /**
     * 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
     */
    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;

    }

    /**
     * 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);

    }

    /**
     * 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;

    }

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

    }

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

            $this->last_name,
        ])->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();
    }

    /**
     * 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;
        }
    }

    /**
     * Mutate the 'first_name' attribute.
     *
     * @param string|null $value
     */
    public function setFirstNameAttribute(string $value = null)
    {
        if (! is_null($value)) {
            $this->attributes['first_name'] = trim($value);
        }
    }

    /**
     * Mutate the 'last_name' attribute.
     *
     * @param string|null $value
     */
    public function setLastNameAttribute(string $value = null)
    {
        if (! is_null($value)) {
            $this->attributes['last_name'] = trim($value);
        }
    }

    /**
     * Access the 'first_name' attribute.
     *
     * @param string|null $value
     * @return string
     */
    public function getFirstNameAttribute(string $value = null): string
    {
        return trim($value);
        return trim(/** @scrutinizer ignore-type */ $value);
    }

    /**
     * Access the 'last_name' attribute.
     *
     * @param string|null $value
     * @return string
     */
    public function getLastNameAttribute(string $value = null): string
    {
        return trim($value);
        return trim(/** @scrutinizer ignore-type */ $value);
    }

    /**
     * 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;


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

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

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

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

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

    }

    /**
     * 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>';
    }

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

    }

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

    }

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

    }

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

    }

    /**
     * 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}" : '';

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

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


        return $footer;
    }
}

sfneal / users

Pull Request — master (#47)

User::query() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
