Skip to content

docs: fix property notation #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2022
Merged

docs: fix property notation #528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ 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
Expand Down Expand Up @@ -57,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
Expand All @@ -76,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 = [
Expand Down