vendor/illuminate/contracts/Auth/Access/Gate.php

   1 <?php
   2
   3 namespace Illuminate\Contracts\Auth\Access;
   4
   5 interface Gate
   6 {
   7     /**
   8      * Determine if a given ability has been defined.
   9      *
  10      * @param  string  $ability
  11      * @return bool
  12      */
  13     public function has($ability);
  14
  15     /**
  16      * Define a new ability.
  17      *
  18      * @param  string  $ability
  19      * @param  callable|string  $callback
  20      * @return $this
  21      */
  22     public function define($ability, $callback);
  23
  24     /**
  25      * Define a policy class for a given class type.
  26      *
  27      * @param  string  $class
  28      * @param  string  $policy
  29      * @return $this
  30      */
  31     public function policy($class, $policy);
  32
  33     /**
  34      * Register a callback to run before all Gate checks.
  35      *
  36      * @param  callable  $callback
  37      * @return $this
  38      */
  39     public function before(callable $callback);
  40
  41     /**
  42      * Register a callback to run after all Gate checks.
  43      *
  44      * @param  callable  $callback
  45      * @return $this
  46      */
  47     public function after(callable $callback);
  48
  49     /**
  50      * Determine if the given ability should be granted for the current user.
  51      *
  52      * @param  string  $ability
  53      * @param  array|mixed  $arguments
  54      * @return bool
  55      */
  56     public function allows($ability, $arguments = []);
  57
  58     /**
  59      * Determine if the given ability should be denied for the current user.
  60      *
  61      * @param  string  $ability
  62      * @param  array|mixed  $arguments
  63      * @return bool
  64      */
  65     public function denies($ability, $arguments = []);
  66
  67     /**
  68      * Determine if all of the given abilities should be granted for the current user.
  69      *
  70      * @param  iterable|string  $abilities
  71      * @param  array|mixed  $arguments
  72      * @return bool
  73      */
  74     public function check($abilities, $arguments = []);
  75
  76     /**
  77      * Determine if any one of the given abilities should be granted for the current user.
  78      *
  79      * @param  iterable|string  $abilities
  80      * @param  array|mixed  $arguments
  81      * @return bool
  82      */
  83     public function any($abilities, $arguments = []);
  84
  85     /**
  86      * Determine if the given ability should be granted for the current user.
  87      *
  88      * @param  string  $ability
  89      * @param  array|mixed  $arguments
  90      * @return \Illuminate\Auth\Access\Response
  91      *
  92      * @throws \Illuminate\Auth\Access\AuthorizationException
  93      */
  94     public function authorize($ability, $arguments = []);
  95
  96     /**
  97      * Get a policy instance for a given class.
  98      *
  99      * @param  object|string  $class
 100      * @return mixed
 101      *
 102      * @throws \InvalidArgumentException
 103      */
 104     public function getPolicyFor($class);
 105
 106     /**
 107      * Get a guard instance for the given user.
 108      *
 109      * @param  \Illuminate\Contracts\Auth\Authenticatable|mixed  $user
 110      * @return static
 111      */
 112     public function forUser($user);
 113
 114     /**
 115      * Get all of the defined abilities.
 116      *
 117      * @return array
 118      */
 119     public function abilities();
 120 }