BookStack/app/User.php

146 lines
3.3 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
*/
2015-08-31 18:59:45 +02:00
protected $fillable = ['name', 'email', 'password'];
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
2015-08-24 22:10:04 +02:00
/**
* Returns a default guest user.
*/
public static function getDefault()
{
return new static([
'email' => 'guest',
2015-08-29 16:03:42 +02:00
'name' => 'Guest'
2015-08-24 22:10:04 +02:00
]);
}
2015-08-29 16:03:42 +02:00
/**
* Permissions and roles
*/
/**
* The roles that belong to the user.
*/
public function roles()
{
return $this->belongsToMany('BookStack\Role');
2015-08-29 16:03:42 +02:00
}
public function getRoleAttribute()
{
return $this->roles()->first();
}
/**
* Check if the user has a particular permission.
* @param $permissionName
* @return bool
*/
public function can($permissionName)
{
if($this->email == 'guest') {
return false;
}
2015-08-29 16:03:42 +02:00
$permissions = $this->role->permissions()->get();
$permissionSearch = $permissions->search(function ($item, $key) use ($permissionName) {
return $item->name == $permissionName;
});
return $permissionSearch !== false;
}
/**
* 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()->sync([$id]);
}
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) {
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,
* Uses Gravatar as the avatar service.
2015-08-29 16:03:42 +02:00
*
2015-08-23 14:41:35 +02:00
* @param int $size
* @return string
*/
public function getAvatar($size = 50)
{
$emailHash = md5(strtolower(trim($this->email)));
return '//www.gravatar.com/avatar/' . $emailHash . '?s=' . $size . '&d=identicon';
}
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()
{
return '/users/' . $this->id;
}
2015-07-12 21:01:42 +02:00
}