guide/auth/login.md

   1 # Log in and out
   2
   3 The auth module provides methods to help you log users in and out of your application.
   4
   5 ## Log in
   6
   7 The [Auth::login] method handles the login.
   8
   9 ~~~
  10 // Handled from a form with inputs with names email / password
  11 $post = $this->request->post();
  12 $success = Auth::instance()->login($post['email'], $post['password']);
  13
  14 if ($success)
  15 {
  16         // Login successful, send to app
  17 }
  18 else
  19 {
  20         // Login failed, send back to form with error message
  21 }
  22 ~~~
  23
  24 ## Logged in User
  25
  26 There are two ways to check if a user is logged in. If you just need to check if the user is logged in use [Auth::logged_in].
  27
  28 ~~~
  29 if (Auth::instance()->logged_in())
  30 {
  31         // User is logged in, continue on
  32 }
  33 else
  34 {
  35         // User isn't logged in, redirect to the login form.
  36 }
  37 ~~~
  38
  39 You can also get the logged in user object by using [Auth::get_user]. If the user is null, then no user was found.
  40
  41 ~~~
  42 $user = Auth::instance()->get_user();
  43
  44 // Check for a user (NULL if not user is found)
  45 if ($user !== null)
  46 {
  47          // User is found, continue on
  48 }
  49 else
  50 {
  51         // User was not found, redirect to the login form
  52 }
  53 ~~~
  54
  55 ## Log out
  56
  57 The [Auth::logout] method will take care of logging out a user.
  58
  59 ~~~
  60 Auth::instance()->logout();
  61 // Redirect the user back to login page
  62 ~~~