💡 updated comments

Author: mychidarko

App/Controllers/Auth/AccountController.php

@@ -20,25 +20,12 @@ public function update()
     {
         $userId = Auth::id();
 
-        $data = request(["username", "email", "name"]);
-        $dataKeys = array_keys($data);
-
+        // request::try attempts to retrieve the data passed into it
+        // but unsets the data key if no value is found.
+        $data = request()->try(["username", "email", "name"]);
         $where = ["id" => $userId];
-
         $uniques = ["username", "email"];
 
-        // This part simply removes empty fields from request
-        foreach ($dataKeys as $key) {
-            if (!$data[$key]) {
-                unset($data[$key]);
-                continue;
-            }
-
-            if (!strlen($data[$key])) {
-                unset($data[$key]);
-            }
-        }
-
         // This section removes all uniques not found in request
         foreach ($uniques as $key => $unique) {
             if (!isset($data[$unique])) {

App/Controllers/Auth/LoginController.php

@@ -16,14 +16,16 @@ public function index()
         // your own form rules
         Form::rule("max", function ($field, $value, $params) {
             if (strlen($value) > $params) {
+                // add error sets the error which will display when this rule fails
                 Form::addError($field, "$field can't be more than $params characters");
+                // a rule must return false when it's validation fails
                 return false;
             }
         });
 
         // You can also pass in custom parameters into your
         // form rules. The example below calls the max rule defined
-        // above, and replaces the $params variable with 10.
+        // above, and replaces the $params variable with 15.
         $validation = Form::validate([
             // To pass a param to a rule, just use :
             "username" => "max:15",

App/Controllers/Auth/RegisterController.php

@@ -7,6 +7,7 @@
 
 class RegisterController extends Controller
 {
+    // read the login controller to understand what each feature does.
     public function store()
     {
         $credentials = request(["username", "email", "password"]);

App/Controllers/Controller.php

@@ -17,7 +17,7 @@ public function __construct()
 		parent::__construct();
 
 		// In this version, request isn't initialised for you. You can use
-		// requestData() or request() to get request data or initialise it yourself
+		// request() to get request data or initialise it yourself
 
 		// autoConnect uses the .env variables to quickly connect to db
 		Auth::autoConnect();
@@ -28,6 +28,8 @@ public function __construct()
 		// You can configure auth to get additional customizations
 		// This can be done here with the Auth::config method or
 		// simply in the Config/auth.php file
+
+        // AuthConfig loads up the configuration done in Config/auth.php
 		Auth::config(AuthConfig());
 
 		// You can refer to https://leafphp.netlify.app/#/leaf/v/2.5/core/auth for auth docs

App/Controllers/UsersController.php

@@ -3,6 +3,7 @@
 
 // This is our model, we import it here to use it below
 use App\Models\User;
+use Leaf\Auth;
 use Leaf\Helpers\Password;
 
 /**
@@ -36,21 +37,20 @@ public function login()
         // You can perform operations on your model like this
         $user = User::where("username", $username)->first();
 
-        // auth is initialised in the base controller
+        // auth settings are passed in the base controller
         // login allows us to sign a user in, and also generates
         // a jwt automatically
-        $user = $this->auth->login("users", [
+        $user = Auth::login("users", [
             "username" => $username,
             "password" => $password
         ]);
 
         // password encoding has been configured in the base controller
 
         // This line catches any errors that MAY happen
-        if (!$user) response()->throwErr($this->auth->errors());
+        if (!$user) response()->throwErr(Auth::errors());
 
-        // json is another global shortcut method
-        // it's shorter than $this->json()
+        // output json data or return the response object
         response($user);
     }
 
@@ -65,7 +65,7 @@ public function register()
 
         // You can validate your data with Leaf Form Validation
         $validation = $this->form->validate([
-            "username" => "validUsername",
+            "username" => ["validUsername", "max:10"],
             "email" => "email",
             "password" => "required"
         ]);
@@ -77,12 +77,12 @@ public function register()
         // login, so you don't have to call login again, unless you want
         // to. The 3rd parameter makes sure that the same username
         // and email can't be registered multiple times
-        $user = $this->auth->register("users", $credentials, [
+        $user = Auth::register("users", $credentials, [
             "username", "email"
         ]);
 
         // throw an auth error if there's an issue
-        if (!$user) response()->throwErr($this->auth->errors());
+        if (!$user) response()->throwErr(Auth::errors());
 
         response($user);
     }
@@ -119,7 +119,7 @@ public function reset_password()
         // id retrieves the JWT from the headers, decodes it and returns
         // the user encoded into the token. If there's a problem with the token,
         // we can throw whatever error occurs. This means the user must be logged in.
-        $userId = $this->auth->id() ?? response()->throwErr($this->auth->errors());
+        $userId = Auth::id() ?? response()->throwErr(Auth::errors());
         $password = request("password");
 
         // Get the
@@ -131,8 +131,8 @@ public function reset_password()
         $user->save();
 
         // login again to get new token
-        $user = $this->auth->login("users", ["id" => $userId]);
-        if (!$user) response()->throwErr($this->auth->errors());
+        $user = Auth::login("users", ["id" => $userId]);
+        if (!$user) response()->throwErr(Auth::errors());
 
         response()->json($user);
     }
@@ -143,15 +143,15 @@ public function user() {
 
         // Make sure user is logged in
         // $auth->user() is new in v2.4 of leaf
-        $user = $this->auth->user("users", $hidden);
+        $user = Auth::user("users", $hidden);
 
-        response()->json($user ?? response()->throwErr($this->auth->errors()));
+        response()->json($user ?? response()->throwErr(Auth::errors()));
     }
 
     public function edit()
     {
         // auth->id returns the user id encoded into jwt by default
-        $userId = $this->auth->id() ?? response()->throwErr($this->auth->errors());
+        $userId = Auth::id() ?? response()->throwErr(Auth::errors());
 
         // data to update
         $data = request(["username", "email", "password"]);
@@ -162,8 +162,8 @@ public function edit()
         // params which shouldn't already exist in db
         $uniques = ["username", "email"];
 
-        $user = $this->auth->update("users", $data, $where, $uniques);
+        $user = Auth::update("users", $data, $where, $uniques);
 
-        response()->json($user ?? response()->throwErr($this->auth->errors()));
+        response()->json($user ?? response()->throwErr(Auth::errors()));
     }
 }