Auth.php 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. <?php
  2. namespace Illuminate\Support\Facades;
  3. use Laravel\Ui\UiServiceProvider;
  4. use RuntimeException;
  5. /**
  6. * @method static \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard guard(string|null $name = null)
  7. * @method static \Illuminate\Auth\SessionGuard createSessionDriver(string $name, array $config)
  8. * @method static \Illuminate\Auth\TokenGuard createTokenDriver(string $name, array $config)
  9. * @method static string getDefaultDriver()
  10. * @method static void shouldUse(string $name)
  11. * @method static void setDefaultDriver(string $name)
  12. * @method static \Illuminate\Auth\AuthManager viaRequest(string $driver, callable $callback)
  13. * @method static \Closure userResolver()
  14. * @method static \Illuminate\Auth\AuthManager resolveUsersUsing(\Closure $userResolver)
  15. * @method static \Illuminate\Auth\AuthManager extend(string $driver, \Closure $callback)
  16. * @method static \Illuminate\Auth\AuthManager provider(string $name, \Closure $callback)
  17. * @method static bool hasResolvedGuards()
  18. * @method static \Illuminate\Auth\AuthManager forgetGuards()
  19. * @method static \Illuminate\Auth\AuthManager setApplication(\Illuminate\Contracts\Foundation\Application $app)
  20. * @method static \Illuminate\Contracts\Auth\UserProvider|null createUserProvider(string|null $provider = null)
  21. * @method static string getDefaultUserProvider()
  22. * @method static bool check()
  23. * @method static bool guest()
  24. * @method static \Illuminate\Contracts\Auth\Authenticatable|null user()
  25. * @method static int|string|null id()
  26. * @method static bool validate(array $credentials = [])
  27. * @method static bool hasUser()
  28. * @method static \Illuminate\Contracts\Auth\Guard setUser(\Illuminate\Contracts\Auth\Authenticatable $user)
  29. * @method static bool attempt(array $credentials = [], bool $remember = false)
  30. * @method static bool once(array $credentials = [])
  31. * @method static void login(\Illuminate\Contracts\Auth\Authenticatable $user, bool $remember = false)
  32. * @method static \Illuminate\Contracts\Auth\Authenticatable|false loginUsingId(mixed $id, bool $remember = false)
  33. * @method static \Illuminate\Contracts\Auth\Authenticatable|false onceUsingId(mixed $id)
  34. * @method static bool viaRemember()
  35. * @method static void logout()
  36. * @method static \Symfony\Component\HttpFoundation\Response|null basic(string $field = 'email', array $extraConditions = [])
  37. * @method static \Symfony\Component\HttpFoundation\Response|null onceBasic(string $field = 'email', array $extraConditions = [])
  38. * @method static bool attemptWhen(array $credentials = [], array|callable|null $callbacks = null, bool $remember = false)
  39. * @method static string hashPasswordForCookie(string $passwordHash)
  40. * @method static void logoutCurrentDevice()
  41. * @method static \Illuminate\Contracts\Auth\Authenticatable|null logoutOtherDevices(string $password)
  42. * @method static void attempting(mixed $callback)
  43. * @method static \Illuminate\Contracts\Auth\Authenticatable getLastAttempted()
  44. * @method static string getName()
  45. * @method static string getRecallerName()
  46. * @method static \Illuminate\Auth\SessionGuard setRememberDuration(int $minutes)
  47. * @method static \Illuminate\Contracts\Cookie\QueueingFactory getCookieJar()
  48. * @method static void setCookieJar(\Illuminate\Contracts\Cookie\QueueingFactory $cookie)
  49. * @method static \Illuminate\Contracts\Events\Dispatcher getDispatcher()
  50. * @method static void setDispatcher(\Illuminate\Contracts\Events\Dispatcher $events)
  51. * @method static \Illuminate\Contracts\Session\Session getSession()
  52. * @method static \Illuminate\Contracts\Auth\Authenticatable|null getUser()
  53. * @method static \Symfony\Component\HttpFoundation\Request getRequest()
  54. * @method static \Illuminate\Auth\SessionGuard setRequest(\Symfony\Component\HttpFoundation\Request $request)
  55. * @method static \Illuminate\Support\Timebox getTimebox()
  56. * @method static \Illuminate\Contracts\Auth\Authenticatable authenticate()
  57. * @method static \Illuminate\Auth\SessionGuard forgetUser()
  58. * @method static \Illuminate\Contracts\Auth\UserProvider getProvider()
  59. * @method static void setProvider(\Illuminate\Contracts\Auth\UserProvider $provider)
  60. * @method static void macro(string $name, object|callable $macro)
  61. * @method static void mixin(object $mixin, bool $replace = true)
  62. * @method static bool hasMacro(string $name)
  63. * @method static void flushMacros()
  64. *
  65. * @see \Illuminate\Auth\AuthManager
  66. * @see \Illuminate\Auth\SessionGuard
  67. */
  68. class Auth extends Facade
  69. {
  70. /**
  71. * Get the registered name of the component.
  72. *
  73. * @return string
  74. */
  75. protected static function getFacadeAccessor()
  76. {
  77. return 'auth';
  78. }
  79. /**
  80. * Register the typical authentication routes for an application.
  81. *
  82. * @param array $options
  83. * @return void
  84. *
  85. * @throws \RuntimeException
  86. */
  87. public static function routes(array $options = [])
  88. {
  89. if (! static::$app->providerIsLoaded(UiServiceProvider::class)) {
  90. throw new RuntimeException('In order to use the Auth::routes() method, please install the laravel/ui package.');
  91. }
  92. static::$app->make('router')->auth($options);
  93. }
  94. }