You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/0 - install.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
# Installation
2
2
3
-
These instructions assume that you have already [installed the CodeIgniter 4 app starter](https://codeigniter.com/user_guide/installation/installing_composer.html) as the basis for your new project, that you have setup your `.env` file and created a database, and can access
4
-
it via the Spark CLI script.
3
+
These instructions assume that you have already [installed the CodeIgniter 4 app starter](https://codeigniter.com/user_guide/installation/installing_composer.html) as the basis for your new project, set up your `.env` file, and created a database that you can access via the Spark CLI script.
5
4
6
5
Installation is done through [Composer](https://getcomposer.org). The example assumes you have it installed globally.
7
6
If you have it installed as a phar, or othewise you will need to adjust the way you call composer itself.
Copy file name to clipboardExpand all lines: docs/1 - concepts.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ on the standard Config class if nothing is found in the database.
17
17
18
18
## User Providers
19
19
20
-
You can use your own models to handle user persistence. Shield calls this class the `User Provider` class. A default model
20
+
You can use your own models to handle user persistence. Shield calls this the "User Provider" class. A default model
21
21
is provided for you at `CodeIgniter\Shield\Models\UserModel`. You can change this in the `Config\Auth->userProvider` setting.
22
22
The only requirement is that your new class MUST extend the provided `UserModel`.
23
23
@@ -31,11 +31,10 @@ User accounts are stored separately from the information needed to identify that
31
31
called User Identities. By default, the library has two types of identities: one for standard email/password information,
32
32
and one for access tokens.
33
33
34
-
By keeping the identity information loosely coupled from the user account itself, it frees the system up to more easily
35
-
integrate third-party sign-in systems, JWT systems, and more, all on a single user.
34
+
Keeping these identities loosely coupled from the user account itself facilitates integrations with third-party sign-in systems, JWT systems, and more - all on a single user.
36
35
37
36
While this has the potential to make the system more complex, the `email` and `password` fields are automatically
38
-
looked up for you when attempting to access from the User entity. Caution should be used to craft queries that will pull
37
+
looked up for you when attempting to access them from the User entity. Caution should be used to craft queries that will pull
39
38
in the `email` field when you need to display it to the user, as you could easily run into some n+1 slow queries otherwise.
40
39
41
40
When you `save($user)` a `User` instance in the `UserModel`, the email/password identity will automatically be updated.
Copy file name to clipboardExpand all lines: docs/7 - customization.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,17 +53,17 @@ public function loginRedirect(): string
53
53
Shield has the following controllers that can be extended to handle
54
54
various parts of the authentication process:
55
55
56
-
-**ActionController** handles the afterlogin and after-registration actions that can be ran, like Two Factor Authentication and Email Verification.
56
+
-**ActionController** handles the after-login and after-registration actions, like Two Factor Authentication and Email Verification.
57
57
58
58
-**LoginController** handles the login process.
59
59
60
60
-**RegisterController** handles the registration process. Overriding this class allows you to customize the User Provider, the User Entity, and the validation rules.
61
61
62
-
-**MagicLinkController** handles the "lost password" process that allows a user to login with a link sent to their email. Allows you to
62
+
-**MagicLinkController** handles the "lost password" process that allows a user to login with a link sent to their email. This allows you to
63
63
override the message that is displayed to a user to describe what is happening, if you'd like to provide more information than simply swapping out the view used.
64
64
65
-
It is not recommended to copy the entire controller into app and change it's namespace. Instead, you should create a new controller that extends
66
-
the existing controller and then only override the methods needed. This allows the other methods to always stay up to date with any security
65
+
It is not recommended to copy the entire controller into **app/Controllers** and change its namespace. Instead, you should create a new controller that extends
66
+
the existing controller and then only override the methods needed. This allows the other methods to stay up to date with any security
0 commit comments