50 lines
1.1 KiB
PHP
50 lines
1.1 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Spatie\Permission\Contracts;
|
||
|
|
|
||
|
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||
|
|
|
||
|
|
interface Permission
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* A permission can be applied to roles.
|
||
|
|
*
|
||
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
||
|
|
*/
|
||
|
|
public function roles(): BelongsToMany;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find a permission by its name.
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @param string|null $guardName
|
||
|
|
*
|
||
|
|
* @throws \Spatie\Permission\Exceptions\PermissionDoesNotExist
|
||
|
|
*
|
||
|
|
* @return Permission
|
||
|
|
*/
|
||
|
|
public static function findByName(string $name, $guardName): self;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find a permission by its id.
|
||
|
|
*
|
||
|
|
* @param int $id
|
||
|
|
* @param string|null $guardName
|
||
|
|
*
|
||
|
|
* @throws \Spatie\Permission\Exceptions\PermissionDoesNotExist
|
||
|
|
*
|
||
|
|
* @return Permission
|
||
|
|
*/
|
||
|
|
public static function findById(int $id, $guardName): self;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find or Create a permission by its name and guard name.
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
* @param string|null $guardName
|
||
|
|
*
|
||
|
|
* @return Permission
|
||
|
|
*/
|
||
|
|
public static function findOrCreate(string $name, $guardName): self;
|
||
|
|
}
|