1. interface
  2. Hypervel
  3. \
  4. Permission
  5. \
  6. Contracts
  7. \
  8. Role

Role

interface Role mixin Role

Properties

int|string $id
string $name
null|string $guard_name

Methods

BelongsToMany
permissions()

Get the permissions given to this role.

static Role
findByName(UnitEnum|string $name, string|null $guardName)

Find a role by its name and guard name.

static Role
findById(int|string $id, string|null $guardName)

Find a role by its id and guard name.

static Role
findOrCreate(UnitEnum|string $name, string|null $guardName)

Find or create a role by its name and guard name.

bool
hasPermissionTo(UnitEnum|int|string|Permission $permission, string|null $guardName = null)

Determine if the user may perform the given permission.

Details

at line 26
BelongsToMany permissions()

Get the permissions given to this role.

Return Value

BelongsToMany

at line 33
static Role findByName(UnitEnum|string $name, string|null $guardName)

Find a role by its name and guard name.

Parameters

UnitEnum|string $name
string|null $guardName

Return Value

Role

Exceptions

RoleDoesNotExist

at line 40
static Role findById(int|string $id, string|null $guardName)

Find a role by its id and guard name.

Parameters

int|string $id
string|null $guardName

Return Value

Role

Exceptions

RoleDoesNotExist

at line 45
static Role findOrCreate(UnitEnum|string $name, string|null $guardName)

Find or create a role by its name and guard name.

Parameters

UnitEnum|string $name
string|null $guardName

Return Value

Role

at line 50
bool hasPermissionTo(UnitEnum|int|string|Permission $permission, string|null $guardName = null)

Determine if the user may perform the given permission.

Parameters

UnitEnum|int|string|Permission $permission
string|null $guardName

Return Value

bool