blob: faf1497d5f84671ba71905f227a3f163fb94d7fa [file] [log] [blame]
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +02001<?php
2
3namespace Illuminate\Contracts\Auth;
4
5interface StatefulGuard extends Guard
6{
7 /**
8 * Attempt to authenticate a user using the given credentials.
9 *
10 * @param array $credentials
11 * @param bool $remember
12 * @return bool
13 */
14 public function attempt(array $credentials = [], $remember = false);
15
16 /**
17 * Log a user into the application without sessions or cookies.
18 *
19 * @param array $credentials
20 * @return bool
21 */
22 public function once(array $credentials = []);
23
24 /**
25 * Log a user into the application.
26 *
27 * @param \Illuminate\Contracts\Auth\Authenticatable $user
28 * @param bool $remember
29 * @return void
30 */
31 public function login(Authenticatable $user, $remember = false);
32
33 /**
34 * Log the given user ID into the application.
35 *
36 * @param mixed $id
37 * @param bool $remember
38 * @return \Illuminate\Contracts\Auth\Authenticatable|bool
39 */
40 public function loginUsingId($id, $remember = false);
41
42 /**
43 * Log the given user ID into the application without sessions or cookies.
44 *
45 * @param mixed $id
46 * @return \Illuminate\Contracts\Auth\Authenticatable|bool
47 */
48 public function onceUsingId($id);
49
50 /**
51 * Determine if the user was authenticated via "remember me" cookie.
52 *
53 * @return bool
54 */
55 public function viaRemember();
56
57 /**
58 * Log the user out of the application.
59 *
60 * @return void
61 */
62 public function logout();
63}