Skip to content
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.

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

To fix #38 #86

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,38 +152,38 @@ The following options are available:
registration form. Default is `false`.
- **auth_identity_fields** - Array value, specifies which fields a user can
use as the 'identity' field when logging in. Acceptable values: username, email.
Default is `false``.
- **enable_display_name** - Boolean value, enables a display name field on the
registration form. Default value is `false`.
- **enable_registration** - Boolean value, Determines if a user should be
allowed to register. Default value is `true`.
- **login_after_registration** - Boolean value, automatically logs the user in
after they successfully register. Default value is `false`.
after they successfully register. Default value is `true`.
- **use_registration_form_captcha** - Boolean value, determines if a captcha should
be utilized on the user registration form. Default value is `true`. (Note,
right now this only utilizes a weak Laminas\Text\Figlet CAPTCHA, but I have plans
to make all Laminas\Captcha adapters work.)
be utilized on the user registration form. Default value is `false`. (Note,
right now this only utilizes a weak Laminas\Text\Figlet CAPTCHA.)
- **login_form_timeout** - Integer value, specify the timeout for the CSRF security
field of the login form in seconds. Default value is 300 seconds.
- **user_form_timeout** - Integer value, specify the timeout for the CSRF security
field of the registration form in seconds. Default value is 300 seconds.
- **use_redirect_parameter_if_present** - Boolean value, if a redirect GET
parameter is specified, the user will be redirected to the specified URL if
authentication is successful (if present, a GET parameter will override the
login_redirect_route specified below).
login_redirect_route specified below). Default is `true`.
- **login_redirect_route** String value, name of a route in the application
which the user will be redirected to after a successful login.
which the user will be redirected to after a successful login. Default is `lmcuser`.
- **logout_redirect_route** String value, name of a route in the application which
the user will be redirected to after logging out.
the user will be redirected to after logging out. Default is `lmcuser/login`.
- **password_cost** - This should be an integer between 4 and 31. The number
represents the base-2 logarithm of the iteration count used for hashing.
Default is `10` (about 10 hashes per second on an i5).
Default is `14`.
- **enable_user_state** - Boolean value, enable user state usage. Should user's
state be used in the registration/login process?
state be used in the registration/login process? Default is `false`.
- **default_user_state** - Integer value, default user state upon registration.
What state user should have upon registration?
What state user should have upon registration? Default is `1`.
- **allowed_login_states** - Array value, states which are allowing user to login.
When user tries to login, is his/her state one of the following? Include null if
you want user's with no state to login as well.
you want user's with no state to login as well. Default values are `null` and `1`.

Changing Registration Captcha Element
-------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions config/lmcuser.global.php.dist
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ $settings = [
* instead of the default one provided. Default is LmcUser\Entity\User.
* The entity class should implement LmcUser\Entity\UserInterface
*/
//'user_entity_class' => \LmcUser\Entity\User::class,
//'user_entity_class' => 'LmcUser\Entity\User',

/**
* Enable registration
Expand Down Expand Up @@ -52,7 +52,7 @@ $settings = [
* Default value: array containing 'LmcUser\Authentication\Adapter\Db' with priority 100
* Accepted values: array containing services that implement 'LmcUser\Authentication\Adapter\ChainableAdapter'
*/
'auth_adapters' => [100 => \LmcUser\Authentication\Adapter\Db::class],
'auth_adapters' => [100 => '\LmcUser\Authentication\Adapter\Db'],

/**
* Enable Display Name
Expand All @@ -62,7 +62,7 @@ $settings = [
*
* Accepted values: boolean true or false
*/
//'enable_display_name' => true,
//'enable_display_name' => false,

/**
* Modes for authentication identity match
Expand Down Expand Up @@ -211,7 +211,7 @@ $settings = [
*
* Should user's state be used in the registration/login process?
*/
//'enable_user_state' => true,
//'enable_user_state' => false,

/**
* Default user state upon registration
Expand Down