BookStack/app/User.php

239 lines
5.7 KiB
PHP
Raw Normal View History

<?php namespace BookStack;
2015-07-12 15:01:42 -04:00
use BookStack\Notifications\ResetPassword;
2015-07-12 15:01:42 -04:00
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Notifications\Notifiable;
2015-07-12 15:01:42 -04:00
class User extends Model implements AuthenticatableContract, CanResetPasswordContract
{
use Authenticatable, CanResetPassword, Notifiable;
2015-07-12 15:01:42 -04:00
/**
* The database table used by the model.
* @var string
*/
protected $table = 'users';
/**
* The attributes that are mass assignable.
* @var array
*/
protected $fillable = ['name', 'email', 'image_id'];
2015-07-12 15:01:42 -04:00
/**
* The attributes excluded from the model's JSON form.
* @var array
*/
protected $hidden = ['password', 'remember_token'];
2015-08-23 08:41:35 -04:00
/**
* This holds the user's permissions when loaded.
* @var array
*/
protected $permissions;
2015-08-24 16:10:04 -04:00
/**
* Returns the default public user.
* @return User
2015-08-24 16:10:04 -04:00
*/
public static function getDefault()
{
return static::where('system_name', '=', 'public')->first();
}
/**
* Check if the user is the default public user.
* @return bool
*/
public function isDefault()
{
return $this->system_name === 'public';
2015-08-24 16:10:04 -04:00
}
2015-08-29 10:03:42 -04:00
/**
* The roles that belong to the user.
* @return BelongsToMany
2015-08-29 10:03:42 -04:00
*/
public function roles()
{
if ($this->id === 0) {
return ;
}
return $this->belongsToMany(Role::class);
2015-08-29 10:03:42 -04:00
}
/**
* Check if the user has a role.
* @param $role
* @return mixed
*/
public function hasRole($role)
2015-08-29 10:03:42 -04:00
{
return $this->roles->pluck('name')->contains($role);
}
2017-01-01 16:21:11 -05:00
/**
* Check if the user has a role.
* @param $role
* @return mixed
*/
public function hasSystemRole($role)
{
return $this->roles->pluck('system_name')->contains($role);
2017-01-01 16:21:11 -05:00
}
/**
* Get all permissions belonging to a the current user.
* @param bool $cache
* @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
*/
public function permissions($cache = true)
{
if (isset($this->permissions) && $cache) {
return $this->permissions;
}
$this->load('roles.permissions');
$permissions = $this->roles->map(function ($role) {
return $role->permissions;
})->flatten()->unique();
$this->permissions = $permissions;
return $permissions;
2015-08-29 10:03:42 -04:00
}
/**
* Check if the user has a particular permission.
* @param $permissionName
* @return bool
*/
public function can($permissionName)
{
if ($this->email === 'guest') {
return false;
}
return $this->permissions()->pluck('name')->contains($permissionName);
2015-08-29 10:03:42 -04:00
}
/**
* Attach a role to this user.
* @param Role $role
*/
public function attachRole(Role $role)
{
$this->attachRoleId($role->id);
}
/**
* Attach a role id to this user.
* @param $id
*/
public function attachRoleId($id)
{
$this->roles()->attach($id);
2015-08-29 10:03:42 -04:00
}
2015-09-04 15:40:36 -04:00
/**
* Get the social account associated with this user.
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function socialAccounts()
{
return $this->hasMany(SocialAccount::class);
2015-09-04 15:40:36 -04:00
}
/**
* Check if the user has a social account,
* If a driver is passed it checks for that single account type.
* @param bool|string $socialDriver
* @return bool
*/
public function hasSocialAccount($socialDriver = false)
{
if ($socialDriver === false) {
2015-09-04 15:40:36 -04:00
return $this->socialAccounts()->count() > 0;
}
return $this->socialAccounts()->where('driver', '=', $socialDriver)->exists();
}
2015-08-23 08:41:35 -04:00
/**
* Returns the user's avatar,
* @param int $size
* @return string
*/
public function getAvatar($size = 50)
{
$default = baseUrl('/user_avatar.png');
$imageId = $this->image_id;
if ($imageId === 0 || $imageId === '0' || $imageId === null) {
return $default;
}
try {
$avatar = $this->avatar ? baseUrl($this->avatar->getThumb($size, $size, false)) : $default;
} catch (\Exception $err) {
$avatar = $default;
}
return $avatar;
2015-12-09 17:30:55 -05:00
}
/**
* Get the avatar for the user.
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function avatar()
{
return $this->belongsTo(Image::class, 'image_id');
2015-08-23 08:41:35 -04:00
}
2015-09-04 15:40:36 -04:00
2015-09-21 15:54:11 -04:00
/**
* Get the url for editing this user.
* @return string
*/
2015-09-04 15:40:36 -04:00
public function getEditUrl()
{
2016-08-13 12:56:20 -04:00
return baseUrl('/settings/users/' . $this->id);
2015-09-04 15:40:36 -04:00
}
2016-03-30 16:28:38 -04:00
/**
* Get the url that links to this user's profile.
* @return mixed
*/
public function getProfileUrl()
{
return baseUrl('/user/' . $this->id);
}
2016-03-30 16:28:38 -04:00
/**
* Get a shortened version of the user's name.
* @param int $chars
* @return string
*/
public function getShortName($chars = 8)
{
if (strlen($this->name) <= $chars) {
return $this->name;
}
2016-03-30 16:28:38 -04:00
$splitName = explode(' ', $this->name);
if (strlen($splitName[0]) <= $chars) {
return $splitName[0];
}
2016-03-30 16:28:38 -04:00
return '';
}
/**
* Send the password reset notification.
* @param string $token
* @return void
*/
public function sendPasswordResetNotification($token)
{
$this->notify(new ResetPassword($token));
}
2015-07-12 15:01:42 -04:00
}