summaryrefslogtreecommitdiff
path: root/src/Models/Auth/Role.php
blob: ede93ae149add7544a43c9e18b97a4cb875a563f (plain)
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
<?php

namespace Engelsystem\Models\Auth;

use Engelsystem\Models\BaseModel;
use Engelsystem\Models\Team;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Staudenmeir\EloquentHasManyDeep\HasManyDeep;

/**
 * @property integer                                                                       $id
 * @property string                                                                        $name
 * @property string|null                                                                   $description
 * @property \Carbon\Carbon                                                                $created_at
 * @property \Carbon\Carbon                                                                $updated_at
 *
 * @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\Auth\Permission[] $permissions
 * @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\Team[]            $teams
 * @property-read \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User[]       $users
 *
 * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User   whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User[] whereName($value)
 * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User[] whereDescription($value)
 * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User[] whereCreatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\Engelsystem\Models\User\User[] whereUpdatedAt($value)
 */
class Role extends BaseModel
{
    /** @var bool enable timestamps */
    public $timestamps = true;

    /** The attributes that are mass assignable */
    protected $fillable = [
        'name',
        'description',
    ];

    /**
     * The roles permissions
     *
     * @return BelongsToMany
     */
    public function permissions()
    {
        return $this
            ->belongsToMany(Permission::class)
            ->withTimestamps();
    }

    /**
     * The teams that that have the role assigned
     *
     * @return BelongsToMany
     */
    public function teams()
    {
        return $this
            ->belongsToMany(Team::class)
            ->withTimestamps();
    }

    /**
     * The users that that have the role assigned
     *
     * @return HasManyDeep
     */
    public function users()
    {
        return $this->hasManyDeepFromRelations($this->teams(), (new Team)->users());
    }
}