4.1. Users

Top  Previous  Next

Users module includes all functions related to user handling, such as user login, registration forms and etc.

Module functions:

registration - allows users to register in the system
Parameters:
o user_group_id - the optional parameter specifies a user group ID; if it doesn't specify, then this function returns the list of all available user groups to choose.
o reg_form_template - registration form template     
Used templates:
oregistration_choose_user_group.tpl
oregistration_success.tpl
oregistration_form.tpl or the template specified in the property of the registration form template group.

 

login - displays login form
Parameters:
ousername - a name of a user
opassword -  user password
okeep - this flag means whether login information should be saved or not.   
Used templates:
oalready_logged_in.tpl
ologin.tpl

 

logout - logs out users and redirects them to the main page
Parameters: no
Used templates: no

 

activate_account - activates user account
Parameters:
ousername - a name of a user
oactivation_key - activation key 
Used templates:
oactivate_account.tpl

 

password_recovery - recoveries user password
Parameters:
ousername - a name of a user
Used templates:
opassword_recovery.tpl
opassword_change_email_successfully_sent.tpl 

 

change_password - changes user password
Parameters:
ousername - a name of a user
overification_key - verification key 
opassword  - new password
oconfirm_password - password confirmation
Used templates:
ochange_password.tpl
osuccessful_password_change.tpl 

 

edit_profile - edits user profile
Parameters: no
Used templates:
oedit_profile.tpl

 

user_notifications - user notifications management (turn on / turn off)
Parameters: no
Used templates:
ouser_notifications.tpl

 

delete_uploaded_file - deleting an uploaded file of a current user
Parameters:
ofield_id - ID of a user field. A file will be deleted from this user field.
Used templates:
o delete_uploaded_file.tpl