Browse Source

updated user_guide

v3-dev
REJack 6 years ago
parent
commit
ba5b19f312
  1. 6
      user_guide_src/source/changelogs/v3.0.0.rst
  2. 8
      user_guide_src/source/changes/library.rst
  3. 2
      user_guide_src/source/config.rst
  4. 2
      user_guide_src/source/extensions/index.rst
  5. 5
      user_guide_src/source/extensions/oauth2.rst
  6. 6
      user_guide_src/source/extensions/social.rst
  7. 14
      user_guide_src/source/libraries.rst

6
user_guide_src/source/changelogs/v3.0.0.rst

@ -35,11 +35,11 @@ New packages list:
- Models
- \\ Aauth
- \\ GroupModel, LoginAttemptModel, PermToUserModel, GroupToGroupModel, LoginTokenModel,
UserModel, GroupToUserModel, PermModel, UserSessionModel, GroupVariableModel, PermToGroupModel,
UserVariableModel
UserModel, GroupToUserModel, PermModel, UserSessionModel, GroupVariableModel, PermToGroupModel,
UserVariableModel
- Views
- \\ Home
\\ Aauth
- \\ Aauth
- \\ RemindPassword, ResetPassword, Verification
- \\ Account
- \\ Edit, Register, Verification, Home, RemindPassword, Login, ResetPassword

8
user_guide_src/source/changes/library.rst

@ -25,8 +25,8 @@ What's Added?
- setGroupVar()
- unsetGroupVar()
- getGroupVar()
- getGroupVars()
- listGroupVarKeys()
- listGroupVars()
- getGroupVarKeys()
- getModel()
- __call()
@ -69,8 +69,8 @@ What's Renamed?
- set_user_var() => setUserVar()
- unset_user_var() => unsetUserVar()
- get_user_var() => getUserVar()
- get_user_vars() => getUserVars()
- list_user_var_keys() => listUserVarKeys()
- get_user_vars() => listUserVars()
- list_user_var_keys() => getUserVarKeys()
- create_group() => createGroup()
- update_group() => updateGroup()

2
user_guide_src/source/config.rst

@ -6,7 +6,6 @@ All changes inside the Aauth Config
.. contents::
:local:
:depth: 2
Link Variables
==============
@ -19,6 +18,7 @@ Available Options:
- false (control() returns booleans)
- 'error' (control() throws an error)
- any uri/url string (control() redirect to set value)
.. note:: Default value: false

2
user_guide_src/source/extensions/index.rst

@ -7,4 +7,4 @@ Extensions
captcha
totp
oauth2
social

5
user_guide_src/source/extensions/oauth2.rst

@ -1,5 +0,0 @@
######
oAuth2
######
oAuth2 Extensions

6
user_guide_src/source/extensions/social.rst

@ -0,0 +1,6 @@
#############
Social Logins
#############
Social Logins Extensions

14
user_guide_src/source/libraries.rst

@ -245,7 +245,7 @@ Class Reference
:returns: Variable value if success, FALSE if failed
:rtype: boolean|string
.. php:method:: getUserVars([int $userId = null])
.. php:method:: listUserVars([int $userId = null])
Get all user keys & variables
@ -253,12 +253,12 @@ Class Reference
:returns: Array of User variables if success, FALSE if failed
:rtype: boolean|array
.. php:method:: listUserVarKeys([int $userId = null])
.. php:method:: getUserVarKeys([int $userId = null])
Get all User Variable Keys by UserId
:param integer $userId: User id
:returns; Array of User variable keys if success, FALSE if failed
:returns: Array of User variable keys if success, FALSE if failed
:rtype: boolean|array
.. php:method:: createGroup(string $name[, string $definition = ''])
@ -385,9 +385,9 @@ Class Reference
.. php:method:: getGroupName($groupPar)
:param string|integer $groupPar: Group name or id
Get Group name
:param string|integer $groupPar: Group name or id
:returns: Group name or FALSE if group not found
:rtype: boolean|string
@ -453,7 +453,7 @@ Class Reference
:returns: Variable value if success, FALSE if failed
:rtype: boolean|string
.. php:method:: getGroupVars([int $groupPar = null])
.. php:method:: listGroupVars([int $groupPar = null])
Get all Group Variables
@ -461,12 +461,12 @@ Class Reference
:returns: Array of Group variables if success, FALSE if failed
:rtype: boolean|array
.. php:method:: listGroupVarKeys([int $groupPar = null])
.. php:method:: getGroupVarKeys([int $groupPar = null])
List Group Variable Keys
:param string|integer $groupPar: Group name or id
:returns; Array of Group variable keys if success, FALSE if failed
:returns: Array of Group variable keys if success, FALSE if failed
:rtype: boolean|array
.. php:method:: createPerm(string $name[, string $definition = ''])

Loading…
Cancel
Save