'boolean', 'use_totp' => 'boolean', 'gravatar' => 'boolean', ]; /** * @var array */ protected $dates = [self::CREATED_AT, self::UPDATED_AT, 'totp_authenticated_at']; /** * The attributes excluded from the model's JSON form. * * @var array */ protected $hidden = ['password', 'remember_token', 'totp_secret', 'totp_authenticated_at']; /** * Parameters for search querying. * * @var array */ protected $searchableColumns = [ 'username' => 100, 'email' => 100, 'external_id' => 80, 'uuid' => 80, 'name_first' => 40, 'name_last' => 40, ]; /** * Default values for specific fields in the database. * * @var array */ protected $attributes = [ 'external_id' => null, 'root_admin' => false, 'language' => 'en', 'use_totp' => false, 'totp_secret' => null, ]; /** * Rules verifying that the data being stored matches the expectations of the database. * * @var array */ public static $validationRules = [ 'uuid' => 'required|string|size:36|unique:users,uuid', 'email' => 'required|email|unique:users,email', 'external_id' => 'sometimes|nullable|string|max:255|unique:users,external_id', 'username' => 'required|between:1,255|unique:users,username', 'name_first' => 'required|string|between:1,255', 'name_last' => 'required|string|between:1,255', 'password' => 'required|nullable|string', 'root_admin' => 'boolean', 'language' => 'required|string', 'use_totp' => 'boolean', 'totp_secret' => 'nullable|string', ]; /** * Implement language verification by overriding Eloquence's gather * rules function. */ protected static function gatherRules() { $rules['language'][] = new In(array_keys((new self)->getAvailableLanguages())); $rules['username'][] = new Username; return $rules; } /** * Return the user model in a format that can be passed over to Vue templates. * * @return array */ public function toVueObject(): array { return (new Collection($this->toArray()))->except(['id', 'external_id'])->toArray(); } /** * Send the password reset notification. * * @param string $token */ public function sendPasswordResetNotification($token) { $this->notify(new ResetPasswordNotification($token)); } /** * Store the username as a lowercase string. * * @param string $value */ public function setUsernameAttribute(string $value) { $this->attributes['username'] = mb_strtolower($value); } /** * Return a concatenated result for the accounts full name. * * @return string */ public function getNameAttribute() { return $this->name_first . ' ' . $this->name_last; } /** * Returns all permissions that a user has. * * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough */ public function permissions() { return $this->hasManyThrough(Permission::class, Subuser::class); } /** * Returns all servers that a user owns. * * @return \Illuminate\Database\Eloquent\Relations\HasMany */ public function servers() { return $this->hasMany(Server::class, 'owner_id'); } /** * Return all servers that user is listed as a subuser of directly. * * @return \Illuminate\Database\Eloquent\Relations\HasMany */ public function subuserOf() { return $this->hasMany(Subuser::class); } /** * Return all of the daemon keys that a user belongs to. * * @return \Illuminate\Database\Eloquent\Relations\HasMany */ public function keys() { return $this->hasMany(DaemonKey::class); } }