1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?php
/**
* UserFrosting (http://www.userfrosting.com)
*
* @link https://github.com/userfrosting/UserFrosting
* @license https://github.com/userfrosting/UserFrosting/blob/master/licenses/UserFrosting.md (MIT License)
*/
namespace UserFrosting\Sprinkle\Account\Database\Models;
use Illuminate\Database\Capsule\Manager as Capsule;
use UserFrosting\Sprinkle\Core\Database\Models\Model;
/**
* Role Class
*
* Represents a role, which aggregates permissions and to which a user can be assigned.
* @author Alex Weissman (https://alexanderweissman.com)
* @property string slug
* @property string name
* @property string description
*/
class Role extends Model
{
/**
* @var string The name of the table for the current model.
*/
protected $table = "roles";
protected $fillable = [
"slug",
"name",
"description"
];
/**
* @var bool Enable timestamps for this class.
*/
public $timestamps = true;
/**
* Delete this role from the database, removing associations with permissions and users.
*
*/
public function delete()
{
// Remove all permission associations
$this->permissions()->detach();
// Remove all user associations
$this->users()->detach();
// Delete the role
$result = parent::delete();
return $result;
}
/**
* Get a list of default roles.
*/
public static function getDefaultSlugs()
{
/** @var UserFrosting\Config $config */
$config = static::$ci->config;
return array_map('trim', array_keys($config['site.registration.user_defaults.roles'], true));
}
/**
* Get a list of permissions assigned to this role.
*/
public function permissions()
{
/** @var UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
$classMapper = static::$ci->classMapper;
return $this->belongsToMany($classMapper->getClassMapping('permission'), 'permission_roles', 'role_id', 'permission_id')->withTimestamps();
}
/**
* Query scope to get all roles assigned to a specific user.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param int $userId
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeForUser($query, $userId)
{
return $query->join('role_users', function ($join) use ($userId) {
$join->on('role_users.role_id', 'roles.id')
->where('user_id', $userId);
});
}
/**
* Get a list of users who have this role.
*/
public function users()
{
/** @var UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
$classMapper = static::$ci->classMapper;
return $this->belongsToMany($classMapper->getClassMapping('user'), 'role_users', 'role_id', 'user_id');
}
}
|
