jiqu-library-server/app/Models/User.php

<?php

namespace App\Models;

use App\Constants\Device;
use Dcat\Admin\Traits\HasDateTimeFormatter;
use Illuminate\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Support\Facades\Hash;
use Laravel\Sanctum\HasApiTokens;

class User extends Model implements AuthorizableContract, AuthenticatableContract
{
    use Authenticatable;
    use Authorizable;
    use HasFactory;
    use HasApiTokens;
    use HasDateTimeFormatter;

    public const STATUS_FROZEN = -1;            // 冻结
    public const STATUS_INACTIVATED = 0;        // 未激活
    public const STATUS_ACTIVE = 1;             // 正常

    /**
     * @var array
     */
    protected $attributes = [
        'status' => self::STATUS_ACTIVE,
    ];

    /**
     * @var array
     */
    protected $fillable = [
        'username',
        'password',
        'phone',
        'phone_verified_at',
        'email',
        'email_verified_at',
        'last_login_ip',
        'last_login_at',
        'register_ip',
        'status',
        'status_remark',
    ];

    /**
     * @var array
     */
    protected $casts = [
        'phone_verified_at' => 'datetime',
        'email_verified_at' => 'datetime',
        'last_login_at' => 'datetime',
        'status' => 'int',
    ];

    /**
     * 属于此用户的个人信息
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function userInfo(): HasOne
    {
        return $this->hasOne(UserInfo::class);
    }

    /**
     * 用户的VIP信息
     */
    public function userVip()
    {
        return $this->hasOne(UserVip::class, 'user_id');
    }

    /**
     * 属于此用户的购物车中的商品
     */
    public function shoppingCartItems()
    {
        return $this->hasMany(ShoppingCartItem::class);
    }

    /**
     * 属于此用户的收货地址
     */
    public function shippingAddresses()
    {
        return $this->hasMany(ShippingAddress::class);
    }

    /**
     * 属于此用户的订单
     */
    public function orders()
    {
        return $this->hasMany(Order::class);
    }

    /**
     * 属于此用户的商品收藏记录
     */
    public function skuFavorites()
    {
        return $this->hasMany(ProductSkuFavorite::class);
    }

    /**
     * 确认此用户是否是 VIP
     *
     * @return bool
     */
    public function isVip(): bool
    {
        return false;
    }

    /**
     * 属于此用户的售后订单
     */
    public function afterSales()
    {
        return $this->hasMany(AfterSale::class);
    }

    /**
     * 属于此用户的优惠券
     *
     * @return void
     */
    public function coupons()
    {
        return $this->hasMany(UserCoupon::class);
    }

    /**
     * 签到情况
     *
     * @return void
     */
    public function click()
    {
        return $this->hasOne(Click::class, 'user_id');
    }

    /**
     * 用户签到记录
     *
     * @return void
     */
    public function clickLogs()
    {
        return $this->hasMany(ClickLog::class);
    }

    /**
     * 禁用用户
     *
     * @param string|null $status_remarks
     * @return void
     */
    public function disable(?string $status_remark = null)
    {
        $res = null;
        if ($this->status == 1) {//只操作正常用户
            $this->status = 2;
            $this->status_remark = $status_remark;
            $res = $this->save();
        }

        return $res;
    }

    /**
     * 启用用户
     *
     * @return void
     */
    public function enable()
    {
        $res = null;
        if ($this->status != 1) {//
            $this->status = 1;
            $res = $this->save();
        }
        return $res;
    }

    /**
     * 设置此用户的密码
     *
     * @param string $value
     * @return void
     */
    public function setPasswordAttribute($value): void
    {
        if ((string) $value === '') {
            $value = null;
        } elseif (Hash::needsRehash($value)) {
            $value = Hash::make($value);
        }

        $this->attributes['password'] = $value;
    }

    /**
     * 确认给定的密码是否正确
     *
     * @param string $password
     * @return bool
     */
    public function verifyPassword(string $password): bool
    {
        return $this->password && Hash::check($password, $this->password);
    }

    /**
     * 创建设备授权令牌
     *
     * @param string $device
     * @return array
     */
    public function createDeviceToken(string $device = null): array
    {
        return [
            'token' => $this->createToken($device ?: Device::PC)->plainTextToken,
        ];
    }

    /**
     * 创建用户
     *
     * @param array $attributes
     * @param self|null $inviter
     * @return self
     */
    public static function create(array $attributes = [], ?self $inviter = null): self
    {
        $user = static::query()->create($attributes);

        $user->userInfo()->create([
            'inviter_id' => $inviter?->id,
        ]);

        return $user;
    }
}