Misterzym
/
CodeIgniter-Aauth
mirror of https://github.com/misterzym/CodeIgniter-Aauth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

updated Config/Aauth docs

v3-dev
REJack 6 years ago
parent
712edbd670
commit
5ed33368dc
1 changed files with 66 additions and 58 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 124
      app/Config/Aauth.php

124
app/Config/Aauth.php
Unescape View File

@ -39,9 +39,9 @@ class Aauth extends BaseConfig
| If user don't have permission to see the page he will be redirected | If user don't have permission to see the page he will be redirected
| the page specified. | the page specified.
| Available Options: | Available Options:
| - false (control() returns booleans) | - false (control() returns booleans)
| - 'error' (control() throws an error) | - 'error' (control() throws an error)
| - any uri/url string (control() redirect to set value) | - any uri/url string (control() redirect to set value)
| (default: false) | (default: false)
| |
| 'linkResetPassword' | 'linkResetPassword'
@ -78,6 +78,7 @@ class Aauth extends BaseConfig
| |
| Regex pattern for valid chars for username | Regex pattern for valid chars for username
| (default: '^[a-zA-Z0-9]{3,}$') | (default: '^[a-zA-Z0-9]{3,}$')
|
*/ */
public $userActiveTime = '5 minutes'; public $userActiveTime = '5 minutes';
public $userVerification = false; public $userVerification = false;
@ -90,25 +91,26 @@ class Aauth extends BaseConfig
| |
| 'passwordMin' | 'passwordMin'
| |
| Password min char length | Password min char length
| (default: 8) | (default: 8)
| |
| 'passwordMax' | 'passwordMax'
| |
| Password max char length | Password max char length
| (default: 32) | (default: 32)
| |
| 'passwordHashAlgo' | 'passwordHashAlgo'
| |
| password_hash algorithm (PASSWORD_DEFAULT, PASSWORD_BCRYPT) | password_hash algorithm (PASSWORD_DEFAULT, PASSWORD_BCRYPT)
| for details see http://php.net/manual/de/password.constants.php | for details see http://php.net/manual/de/password.constants.php
| (default: PASSWORD_DEFAULT) | (default: PASSWORD_DEFAULT)
| |
| 'passwordHashOptions' | 'passwordHashOptions'
| |
| password_hash options array | password_hash options array
| for details see http://php.net/manual/en/function.password-hash.php | for details see http://php.net/manual/en/function.password-hash.php
| (default: []) | (default: [])
|
*/ */
public $passwordMin = 8; public $passwordMin = 8;
public $passwordMax = 32; public $passwordMax = 32;
@ -173,6 +175,7 @@ class Aauth extends BaseConfig
| |
| Enables removing login attempt after successful login | Enables removing login attempt after successful login
| (default: true) | (default: true)
|
*/ */
public $loginRemember = '+14 days'; public $loginRemember = '+14 days';
public $loginRememberCookie = 'remember'; public $loginRememberCookie = 'remember';
@ -206,6 +209,7 @@ class Aauth extends BaseConfig
| |
| Array of Config for CI's Email Library | Array of Config for CI's Email Library
| (default: []) | (default: [])
|
*/ */
public $emailFrom = 'sys@xpresspaper.eu'; public $emailFrom = 'sys@xpresspaper.eu';
public $emailFromName = 'Aauth v3'; public $emailFromName = 'Aauth v3';
@ -240,6 +244,7 @@ class Aauth extends BaseConfig
| |
| Redirect path to TOTP Verification page | Redirect path to TOTP Verification page
| (default: '/account/twofactor_verification/index') | (default: '/account/twofactor_verification/index')
|
*/ */
public $totpEnabled = false; public $totpEnabled = false;
public $totpOnIpChange = false; public $totpOnIpChange = false;
@ -261,8 +266,8 @@ class Aauth extends BaseConfig
| |
| CAPTCHA Types | CAPTCHA Types
| Available Options: | Available Options:
| - 'recaptcha' (for details see https://www.google.com/captcha/admin) | - 'recaptcha' (for details see https://www.google.com/captcha/admin)
| - 'hcaptcha' (for details see https://hcaptcha.com/docs) | - 'hcaptcha' (for details see https://hcaptcha.com/docs)
| (default: 'recaptcha') | (default: 'recaptcha')
| |
| 'captchaLoginAttempts' | 'captchaLoginAttempts'
@ -279,6 +284,7 @@ class Aauth extends BaseConfig
| |
| The CAPTCHA secretKey | The CAPTCHA secretKey
| (default: '') | (default: '')
|
*/ */
public $captchaEnabled = false; public $captchaEnabled = false;
public $captchaType = 'recaptcha'; public $captchaType = 'recaptcha';
@ -293,18 +299,19 @@ class Aauth extends BaseConfig
| |
| 'groupAdmin' | 'groupAdmin'
| |
| Name of admin group | Name of admin group
| (default: 'admin') | (default: 'admin')
| |
| 'groupDefault' | 'groupDefault'
| |
| Name of default group, the new user is added in it | Name of default group, the new user is added in it
| (default: 'default') | (default: 'default')
| |
| 'groupPublic' | 'groupPublic'
| |
| Name of Public group , people who not logged in | Name of Public group , people who not logged in
| (default: 'public') | (default: 'public')
|
*/ */
public $groupAdmin = 'admin'; public $groupAdmin = 'admin';
public $groupDefault = 'default'; public $groupDefault = 'default';
@ -317,8 +324,8 @@ class Aauth extends BaseConfig
| |
| 'modules' | 'modules'
| |
| Array of active modules | Array of active modules
| (default: []) | (default: [])
| |
*/ */
public $modules = []; public $modules = [];
@ -330,95 +337,96 @@ class Aauth extends BaseConfig
| |
| 'dbProfile' | 'dbProfile'
| |
| The configuration database profile (defined in Config/Database.php) | The configuration database profile (defined in Config/Database.php)
| (default: 'default') | (default: 'default')
| |
| 'dbReturnType' | 'dbReturnType'
| |
| The format that the results should be returned as, for any get* & | The format that the results should be returned as, for any get* &
| list* function. (e.g. getUser, listUsers, ...). | list* function. (e.g. getUser, listUsers, ...).
| Available types: | Available types:
| - array | - array
| - object | - object
| (default: 'array') | (default: 'array')
| |
| 'dbTableUsers' | 'dbTableUsers'
| |
| The table which contains users | The table which contains users
| (default: 'aauth_users') | (default: 'aauth_users')
| |
| 'dbTableUserSessions' | 'dbTableUserSessions'
| |
| The table which contains user sessions | The table which contains user sessions
| (default: 'aauth_user_sessions') | (default: 'aauth_user_sessions')
| |
| 'dbTableUserVariables' | 'dbTableUserVariables'
| |
| The table which contains users variables | The table which contains users variables
| (default: 'aauth_user_variables') | (default: 'aauth_user_variables')
| |
| 'dbTableLoginAttempts' | 'dbTableLoginAttempts'
| |
| The table which contains login attempts | The table which contains login attempts
| (default: 'aauth_login_attempts') | (default: 'aauth_login_attempts')
| |
| 'dbTableLoginTokens' | 'dbTableLoginTokens'
| |
| The table which contains login tokens | The table which contains login tokens
| (default: 'aauth_login_tokens') | (default: 'aauth_login_tokens')
| |
| 'dbTableGroups' | 'dbTableGroups'
| |
| The table which contains groups | The table which contains groups
| (default: 'aauth_groups') | (default: 'aauth_groups')
| |
| 'dbTableGroupToUser' | 'dbTableGroupToUser'
| |
| The table which contains join of users and groups | The table which contains join of users and groups
| (default: 'aauth_group_to_user') | (default: 'aauth_group_to_user')
| |
| 'dbTableGroupToGroup' | 'dbTableGroupToGroup'
| |
| The table which contains join of subgroups and groups | The table which contains join of subgroups and groups
| (default: 'aauth_group_to_group') | (default: 'aauth_group_to_group')
| |
| 'dbTableGroupVariables' | 'dbTableGroupVariables'
| |
| The table which contains group variables | The table which contains group variables
| (default: 'aauth_group_variables') | (default: 'aauth_group_variables')
| |
| 'dbTablePerms' | 'dbTablePerms'
| |
| The table which contains permissions | The table which contains permissions
| (default: 'aauth_perms') | (default: 'aauth_perms')
| |
| 'dbTablePermToUser' | 'dbTablePermToUser'
| |
| The table which contains permissions for users | The table which contains permissions for users
| (default: 'aauth_perm_to_user') | (default: 'aauth_perm_to_user')
| |
| 'dbTablePermToGroup' | 'dbTablePermToGroup'
| |
| The table which contains permissions for groups | The table which contains permissions for groups
| (default: 'aauth_perm_to_group') | (default: 'aauth_perm_to_group')
| |
| 'dbSoftDeleteUsers' | 'dbSoftDeleteUsers'
| |
| Enables soft delete for Users | Enables soft delete for Users
| If this is enabled, it simply set a flag when rows are deleted. | If this is enabled, it simply set a flag when rows are deleted.
| (default: false) | (default: false)
| |
| 'dbSoftDeleteGroups' | 'dbSoftDeleteGroups'
| |
| Enables soft delete for Groups | Enables soft delete for Groups
| If this is enabled, it simply set a flag when rows are deleted. | If this is enabled, it simply set a flag when rows are deleted.
| (default: false) | (default: false)
| |
| 'dbSoftDeletePerms' | 'dbSoftDeletePerms'
| |
| Enables soft delete for Perms | Enables soft delete for Perms
| If this is enabled, it simply set a flag when rows are deleted. | If this is enabled, it simply set a flag when rows are deleted.
| (default: false) | (default: false)
|
*/ */
public $dbProfile = 'default'; public $dbProfile = 'default';
public $dbReturnType = 'array'; public $dbReturnType = 'array';

Write Preview
Loading…
Cancel
Save