$preferences * @property-read \Illuminate\Database\Eloquent\Collection|\Laravel\Passport\Client[] $clients * @property-read int|null $clients_count * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\Group[] $groups * @property-read int|null $groups_count * @property-read \Illuminate\Notifications\DatabaseNotificationCollection|\Illuminate\Notifications\DatabaseNotification[] $notifications * @property-read int|null $notifications_count * @property-read \Illuminate\Database\Eloquent\Collection|\Laravel\Passport\Token[] $tokens * @property-read int|null $tokens_count * @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\TwoFAccount[] $twofaccounts * @property-read int|null $twofaccounts_count * @property-read \Illuminate\Database\Eloquent\Collection|\Laragear\WebAuthn\Models\WebAuthnCredential[] $webAuthnCredentials * @property-read int|null $web_authn_credentials_count * @property string|null $oauth_id * @property string|null $oauth_provider * @property-read \Illuminate\Database\Eloquent\Collection $authentications * @property-read int|null $authentications_count * @property-read \App\Models\AuthLog|null $latestAuthentication * * @method static \Illuminate\Database\Eloquent\Builder|User admins() * @method static \Database\Factories\UserFactory factory(...$parameters) * @method static \Illuminate\Database\Eloquent\Builder|User newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|User newQuery() * @method static \Illuminate\Database\Eloquent\Builder|User query() * @method static \Illuminate\Database\Eloquent\Builder|User whereCreatedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereEmail($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereEmailVerifiedAt($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereId($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereIsAdmin($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereLastSeenAt($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereName($value) * @method static \Illuminate\Database\Eloquent\Builder|User wherePassword($value) * @method static \Illuminate\Database\Eloquent\Builder|User wherePreferences($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereRememberToken($value) * @method static \Illuminate\Database\Eloquent\Builder|User whereUpdatedAt($value) * * @mixin \Eloquent */ class User extends Authenticatable implements HasLocalePreference, WebAuthnAuthenticatable { use HasApiTokens, Notifiable; use HasAuthenticationLog; /** * @use HasFactory */ use HasFactory; use WebAuthnAuthentication, WebAuthnManageCredentials; /** * The attributes that are mass assignable. * * @var array */ protected $fillable = [ 'name', 'email', 'password', 'oauth_id', 'oauth_provider', ]; /** * The attributes that should be hidden for serialization. * * @var array */ protected $hidden = [ 'password', 'remember_token', ]; /** * The attributes that should be cast. * * @var array */ protected $casts = [ 'email_verified_at' => 'datetime', 'password' => 'hashed', 'is_admin' => 'boolean', 'twofaccounts_count' => 'integer', 'groups_count' => 'integer', ]; /** * User exposed observable events. * * These are extra user-defined events observers may subscribe to. * * @var array */ protected $observables = ['demoting']; /** * Get the user's preferred locale. */ public function preferredLocale() : string { return strval($this->preferences['lang']); } /** * Scope a query to only include admin users. * * @param \Illuminate\Database\Eloquent\Builder $query * @return \Illuminate\Database\Eloquent\Builder */ public function scopeAdmins($query) { return $query->where('is_admin', true); } /** * Determine if the user is an administrator. * * @return bool */ public function isAdministrator() { return $this->is_admin; } /** * Grant administrator permissions to the user. */ public function promoteToAdministrator(bool $promote = true) : bool { $eventResult = $promote ? $this->fireModelEvent('promoting') : $this->fireModelEvent('demoting'); if ($promote == false && $eventResult === false) { return false; } $this->is_admin = $promote; return true; } /** * Say if the user is the only registered administrator * * @return bool */ public function isLastAdministrator() { $admins = User::admins()->get(); return $admins->contains($this->id) && $admins->count() === 1; } /** * Reset user password with a 12 chars random string. * * @return void */ public function resetPassword() { $this->password = Hash::make(Str::password(12)); event(new PasswordReset($this)); } /** * Send the password reset notification. * * @param string $token * @return void */ public function sendPasswordResetNotification($token) { $this->notify(new ResetPassword($token)); } /** * Get Preferences attribute * * @param string $value * @return \Illuminate\Support\Collection */ public function getPreferencesAttribute($value) { $preferences = collect(config('2fauth.preferences'))->merge(json_decode($value)); /** @phpstan-ignore-line */ return $preferences; } /** * set Email attribute * * @param string $value */ public function setEmailAttribute($value) : void { $this->attributes['email'] = strtolower($value); } /** * Returns an WebAuthnAuthenticatable user from a given Credential ID. */ public static function getFromCredentialId(string $id) : ?WebAuthnAuthenticatable { return static::whereHas( 'webauthnCredentials', static function ($query) use ($id) { return $query->whereKey($id); } )->first(); } /** * Get the TwoFAccounts of the user. * * @return \Illuminate\Database\Eloquent\Relations\HasMany */ public function twofaccounts() { return $this->hasMany(\App\Models\TwoFAccount::class); } /** * Get the Groups of the user. * * @return \Illuminate\Database\Eloquent\Relations\HasMany */ public function groups() { return $this->hasMany(\App\Models\Group::class); } /** * Compare 2 Users */ public function equals(self $other) : bool { return $this->name === $other->name && $this->email === $other->email && $this->oauth_id == $other->oauth_id && $this->oauth_provider == $other->oauth_provider; } }