- User Guide Home
- Installation
-
Auth Configuration
- Internal Auth Config
- General Settings
- Session / Cookie Settings
- Validation / Security Settings
- Email Settings
- Status / Error Messages
- Define Language
- Database Tables and Columns
- Primary User Account Table
- Custom User Account Tables
- User Group Table
- User Privilege Table
- User Privilege Users Table
- User Privilege Groups Table
- User Login Session Table
-
Functions List
- Login / Validation
- Login / Captcha Functions
- Validation Functions
- User Functions
- User Account Functions
- User Group Functions
- User Privilege Functions
- Utility Functions
- Email Functions
- Status / Error Messages
- Customising SQL Statements
- Change Log
User Guide | User Account Functions
Whilst the flexi auth libraries primary purpose is to manage the authentication of a users login credentials, it's next major feature is user management.
The library includes a set of highly configurable database tables and accompanying functions that allow you to handle the data stored for each user, including user group and privilege assignment.
Below is a compiled list of functions and configuration settings to implement and customise the management of user accounts.
User Accounts : User Guide Index
User Account Config | Get User Account Data | Set User Account DataUser Account Configuration
Customise the configuration of the user database tables and how the library handles user account data and behaviours.
Getting User Account Data
Get data from the auth session or database.User Account Data Functions
-
get_user_id()
Get the users id from the session. -
get_user_identity()
Get the users primary identity from the session. -
get_user_by_id()
Get all user data by submitting the users id. -
get_user_by_identity()
Get all user data by submitting the users identity. -
get_users()
Gets data from the user account table and any custom tables that have been related to it. -
get_custom_user_data()
Gets data from the user account table and any custom tables that have been related to it. -
search_users()
Gets data from the user account table via a keyword based search query.
User Activation Functions
-
get_unactivated_users()
Get users that have not activated their account within a set time period. -
resend_activation_token()
Resend user a new activation token incase they have lost the previous one.
User Group Functions
-
get_users_group()
Gets records from the user group table typically for a filtered set of users.
Setting User Account Data
Set data to the database.User Account CRUD Functions
-
insert_user()
Inserts user account and profile data, returning the users new id. -
update_user()
Updates the main user account table and any related custom user tables with the submitted data. -
delete_user()
Deletes a user account and all related custom user tables from the database.
Custom User Data CRUD Functions
-
insert_custom_user_data()
Inserts data into a custom user table and returns the table name and row id of each record inserted. -
update_custom_user_data()
Updates a custom user table with any submitted data. -
delete_custom_user_data()
Deletes a data row from a custom user table.
User Activation Functions
-
activate_user()
Activates a users account allowing them to login to their account. -
deactivate_user()
Deactivates a users account, preventing them from logging in. -
delete_unactivated_users()
Delete users that have not activated their account within a defined time period.
Password Management Functions
-
change_password()
Validates a submitted 'Current' password against the database, if valid, the database is updated with the 'New' password. -
forgotten_password()
Sends the user an email containing a link to verify the user has requested to change their forgotten password. -
validate_forgotten_password()
Validates a forgotten password token. -
forgotten_password_complete()
Validates a forgotten password token and updates the users password.
Email Management Functions
-
update_email_via_verification()
Sends user an email verification token to confirm they own an updated email address. -
verify_updated_email()
Verifies a submitted email verification token and updates the users account with the new email address.
Copyright © 2024, Rob Hussey, All Rights Reserved.
flexi auth was designed and developed by
