Merge branch 'codeigniter4:develop' into patch-1

Author: iamsyh

.github/workflows/docs.yml

@@ -0,0 +1,15 @@
+name: docs 
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -6,3 +6,4 @@ phpunit
 composer.lock
 .DS_Store
 .idea/
+site

README.md

@@ -47,15 +47,16 @@ See the [An Official Auth Library](https://codeigniter.com/news/shield) for more
 
 Usage of Shield requires the following:
 
-- A [CodeIgniter 4.2.3+](https://github.com/codeigniter4/CodeIgniter4/) based project
+- A [CodeIgniter 4.2.7+](https://github.com/codeigniter4/CodeIgniter4/) based project
 - [Composer](https://getcomposer.org/) for package management
 - PHP 7.4.3+
 
 ### Installation
 
 Installation is done through Composer.
-
-    > composer require codeigniter4/shield
+```console
+composer require codeigniter4/shield
+```
 
 See the [docs](docs/index.md) for more specific instructions on installation and usage recommendations.
 

composer.json

@@ -23,7 +23,7 @@
     },
     "require-dev": {
         "codeigniter4/devkit": "^1.0",
-        "codeigniter4/framework": "^4.2.3",
+        "codeigniter4/framework": "^4.2.7",
         "mockery/mockery": "^1.0"
     },
     "provide": {

docs/assets/favicon.ico

@@ -0,0 +1,3 @@
+document.addEventListener('DOMContentLoaded', (event) => {
+    hljs.highlightAll();
+});

docs/assets/flame.svg

@@ -25,15 +25,13 @@ on the standard Config class if nothing is found in the database.
 ## User Providers
 
 You can use your own models to handle user persistence. Shield calls this the "User Provider" class. A default model
-is provided for you at `CodeIgniter\Shield\Models\UserModel`. You can change this in the `Config\Auth->userProvider` setting.
+is provided for you at `CodeIgniter\Shield\Models\UserModel`. You can change this in the `Config\Auth::$userProvider` setting.
 The only requirement is that your new class MUST extend the provided `UserModel`.
 
 ```php
 public $userProvider = 'CodeIgniter\Shield\Models\UserModel';
 ```
 
-<a name="identities" />
-
 ## User Identities
 
 User accounts are stored separately from the information needed to identify that user. These identifying pieces of data are
@@ -59,13 +57,13 @@ systems that are appropriate for your application. The following Validators are
     like ensuring it contained a symbol, a number, etc. According to the current
     [NIST recommendations](https://pages.nist.gov/800-63-3/sp800-63b.html) this only enforces a
     minimum length on the password. You can define the minimum length in
-    `Config\Auth->public $minimumPasswordLength;` This is enabled by default. The default minimum
+    `Config\Auth::$minimumPasswordLength` This is enabled by default. The default minimum
     value is `8`.
 - **NothingPersonalValidator** will compare the password against any fields that have been specified
-    in `Config\Auth->personalFields`, like first or last names, etc. Additionally, it compares it
+    in `Config\Auth::$personalFields`, like first or last names, etc. Additionally, it compares it
     against a few simple variations of the username. If the given password too closely matches
     any of the personal information, it will be rejected. The similarity value is defined in
-     `Config\Auth->maxSimilarity`. The default value is 50, but see the docblock in the config
+     `Config\Auth::$maxSimilarity`. The default value is 50, but see the docblock in the config
      file for more details. This is enabled by default.
 - **DictionaryValidator** will compare the password against a provided file with about 600,000
     frequently used passwords that have been seen in various data dumps over the years. If the
@@ -78,7 +76,7 @@ systems that are appropriate for your application. The following Validators are
     find acceptable. You should use either this validator or the `DictionaryValidator`, not both.
     This is disabled by default.
 
-You can choose which validators are used in `Config\Auth->passwordValidators`:
+You can choose which validators are used in `Config\Auth::$passwordValidators`:
 
 ```php
 public $passwordValidators = [

docs/assets/hljs.js

@@ -10,6 +10,6 @@
 * [Testing](testing.md)
 * [Customization](customization.md)
 
-Guides:
+## Guides
 * [Protecting an API with Access Tokens](guides/api_tokens.md)
 * [Mobile Authentication with Access Tokens](guides/mobile_apps.md)

docs/concepts.md

@@ -17,16 +17,16 @@ These instructions assume that you have already [installed the CodeIgniter 4 app
 ## Requirements
 
 - [Composer](https://getcomposer.org)
-- Codeigniter **v4.2.3** or later
+- Codeigniter **v4.2.7** or later
 - A created database that you can access via the Spark CLI script
 
 ## Composer Installation
 
 Installation is done through [Composer](https://getcomposer.org). The example assumes you have it installed globally.
 If you have it installed as a phar, or otherwise you will need to adjust the way you call composer itself.
 
-```
-> composer require codeigniter4/shield
+```console
+composer require codeigniter4/shield
 ```
 
 ### Troubleshooting
@@ -35,29 +35,29 @@ If you have it installed as a phar, or otherwise you will need to adjust the way
 
 If you get the following error:
 
-```
-  Could not find a version of package codeigniter4/shield matching your minimum-stability (stable).
-  Require it with an explicit version constraint allowing its desired stability.
+```console
+Could not find a version of package codeigniter4/shield matching your minimum-stability (stable).
+Require it with an explicit version constraint allowing its desired stability.
 ```
 
 1. Add the following to change your [minimum-stability](https://getcomposer.org/doc/articles/versions.md#minimum-stability) in your project `composer.json`:
 
     ```json
-        "minimum-stability": "dev",
-        "prefer-stable": true,
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     ```
 
 2. Or specify an explicit version:
 
     ```console
-    > composer require codeigniter4/shield:dev-develop
+    composer require codeigniter4/shield:dev-develop
     ```
 
     The above specifies `develop` branch.
     See https://getcomposer.org/doc/articles/versions.md#branches
 
     ```console
-    > composer require codeigniter4/shield:^1.0.0-beta
+    composer require codeigniter4/shield:^1.0.0-beta
     ```
 
     The above specifies `v1.0.0-beta` or later and before `v2.0.0`.
@@ -70,7 +70,7 @@ If you get the following error:
 1. Run the following command. This command handles steps 1-5 of *Manual Setup* and runs the migrations.
 
     ```console
-    > php spark shield:setup
+    php spark shield:setup
     ```
 
 ### Manual Setup
@@ -120,7 +120,7 @@ your project.
 5. **Migration** Run the migrations.
 
     ```console
-    > php spark migrate --all
+    php spark migrate --all
     ```
 
     #### Note: migration error