BookStack/app/User.php

166 lines
4 KiB
PHP
Raw Normal View History

2015-07-12 21:01:42 +02:00
<?php
namespace BookStack;
2015-07-12 21:01:42 +02:00
use Illuminate\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
class User extends Model implements AuthenticatableContract, CanResetPasswordContract
{
use Authenticatable, CanResetPassword;
/**
* 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 21:01:42 +02:00
/**
* The attributes excluded from the model's JSON form.
* @var array
*/
protected $hidden = ['password', 'remember_token'];
2015-08-23 14:41:35 +02:00
/**
* This holds the user's permissions when loaded.
* @var array
*/
protected $permissions;
2015-08-24 22:10:04 +02:00
/**
* Returns a default guest user.
*/
public static function getDefault()
{
return new static([
'email' => 'guest',
'name' => 'Guest'
2015-08-24 22:10:04 +02:00
]);
}
2015-08-29 16:03:42 +02:00
/**
* The roles that belong to the user.
*/
public function roles()
{
return $this->belongsToMany('BookStack\Role');
2015-08-29 16:03:42 +02:00
}
/**
* Check if the user has a role.
* @param $role
* @return mixed
*/
public function hasRole($role)
2015-08-29 16:03:42 +02:00
{
return $this->roles->pluck('name')->contains($role);
}
/**
* 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 16:03:42 +02: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 16:03:42 +02: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 16:03:42 +02:00
}
2015-09-04 21:40:36 +02:00
/**
* Get the social account associated with this user.
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function socialAccounts()
{
return $this->hasMany('BookStack\SocialAccount');
2015-09-04 21:40:36 +02: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 21:40:36 +02:00
return $this->socialAccounts()->count() > 0;
}
return $this->socialAccounts()->where('driver', '=', $socialDriver)->exists();
}
2015-08-23 14:41:35 +02:00
/**
* Returns the user's avatar,
* @param int $size
* @return string
*/
public function getAvatar($size = 50)
{
if ($this->image_id === 0 || $this->image_id === '0' || $this->image_id === null) return '/user_avatar.png';
2015-12-14 21:13:32 +01:00
return $this->avatar->getThumb($size, $size, false);
2015-12-09 23:30:55 +01:00
}
/**
* Get the avatar for the user.
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function avatar()
{
return $this->belongsTo('BookStack\Image', 'image_id');
2015-08-23 14:41:35 +02:00
}
2015-09-04 21:40:36 +02:00
2015-09-21 21:54:11 +02:00
/**
* Get the url for editing this user.
* @return string
*/
2015-09-04 21:40:36 +02:00
public function getEditUrl()
{
2016-02-16 22:25:11 +01:00
return '/settings/users/' . $this->id;
2015-09-04 21:40:36 +02:00
}
2015-07-12 21:01:42 +02:00
}