[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.user.php (summary)

(no description)

File Size: 1453 lines (47 kb)
Included or required: 60 times
Referenced: 0 times
Includes or requires: 10 files
 include/class.project.php
 include/class.mail.php
 include/class.validation.php
 include/class.misc.php
 include/class.date.php
 include/class.auth.php
 include/class.error_handler.php
 include/class.prefs.php
 include/class.setup.php
 include/class.notification.php

Defines 1 class

User:: (44 methods):
  getUserIDByContactID()
  getEmailByContactID()
  getSMS()
  updateSMS()
  getCustomerContactID()
  getCustomerID()
  confirmVisitorAccount()
  checkHash()
  createVisitorAccount()
  sendPasswordConfirmationEmail()
  confirmNewPassword()
  getUserIDByEmail()
  isActiveStatus()
  isPendingStatus()
  getActiveAssocList()
  getAssocRoleIDs()
  getRoles()
  getRole()
  getRoleID()
  getRoleByUser()
  getDetails()
  getFullName()
  getEmail()
  getGroupID()
  getStatusByEmail()
  changeStatus()
  updatePassword()
  updateFullName()
  updateEmail()
  update()
  insert()
  getList()
  getAssocEmailList()
  getAssocList()
  getNameEmail()
  getFromHeader()
  getClockedInList()
  clockIn()
  clockOut()
  isClockedIn()
  setGroupID()
  getLang()
  setLang()
  setLocalizedRoles()


Class: User  - X-Ref

Class to handle the business logic related to the administration
of users and permissions in the system.

getUserIDByContactID($customer_contact_id)   X-Ref
Method used to get the user ID associated with the given customer
contact ID.

param: integer $customer_contact_id The customer contact ID
return: integer The user ID

getEmailByContactID($customer_contact_id)   X-Ref
Method used to get the account email address associated with the given
customer contact ID.

param: integer $customer_contact_id The customer contact ID
return: string The user's email address

getSMS($usr_id)   X-Ref
Method used to get the SMS email address associated with the given
user ID.

param: integer $usr_id The user ID
return: string The user's SMS email address

updateSMS($usr_id, $sms_email)   X-Ref
Method used to update the SMS email address associated with the given
user ID.

param: integer $usr_id The user ID
param: string $sms_email The user's SMS email address
return: boolean Whether the update was successfull or not

getCustomerContactID($usr_id)   X-Ref
Method used to get the customer contact ID associated with
the given user ID.

param: integer $usr_id The user ID
return: integer The customer contact ID

getCustomerID($usr_id)   X-Ref
Method used to get the customer ID associated with
the given user ID.

param: integer $usr_id The user ID
return: integer The customer ID

confirmVisitorAccount($email)   X-Ref
Method used to update the user account and set the user as a confirmed one.

param: string $email The email address
return: boolean

checkHash($email, $hash)   X-Ref
Method used to check whether the hash passed in the confirmation URL is
a valid one when comparing against the provided email address.

param: string $email The email address associated with the user account
param: string $hash The md5 hash string to be checked against
return: integer -1 if there was an error in the query, -2 for users that don't exist,

createVisitorAccount($role, $projects)   X-Ref
Method used to create a new user account with pending status and send a
confirmation email to the prospective user.

param: string $role The user role
param: array $projects The list of projects that this user will be associated with
return: integer 1 if the creation worked, -1 otherwise

sendPasswordConfirmationEmail($usr_id)   X-Ref
Method used to send a confirmation email to the user that is associated
to the email address.

param: string $usr_id The user ID
return: void

confirmNewPassword($email)   X-Ref
Method used to confirm the request of a new password and send an email
to the user with the new random password.

param: string $email The email address
return: void

getUserIDByEmail($email)   X-Ref
Method used to lookup the user ID of a given email address.

param: string $email The email address associated with the user account
return: integer The user ID

isActiveStatus($status)   X-Ref
Method used to check whether an user is set to status active
or not.

param: string $status The status of the user
return: boolean

isPendingStatus($status)   X-Ref
Method used to check whether an user is set to status pending
or not.

param: string $status The status of the user
return: boolean

getActiveAssocList($prj_id = false, $role = NULL, $exclude_grouped = false, $grp_id = false)   X-Ref
Method used to get the list of all active users available in the system
as an associative array of user IDs => user full names.

param: integer $prj_id The id of the project to show users from
param: integer $role The role ID of the user
param: boolean $exclude_grouped If users with a group should be excluded
param: integer $grp_id The ID of the group.
return: array The associative array of users

getAssocRoleIDs()   X-Ref
Method used to get an associative array of the available roles.

return: array The list of roles

getRoles($exclude_role = FALSE)   X-Ref
Method used to get the full list of roles available in the
system.

param: array $exclude_role The list of roles to ignore
return: array The list of roles

getRole($role_id)   X-Ref
Method used to get the role title for a specific role ID.

param: integer $role_id The role ID
return: string The role title

getRoleID($role_title)   X-Ref
Method used to get the role ID for a specific role title.

param: string $role_title The role title
return: integer The role ID

getRoleByUser($usr_id, $prj_id)   X-Ref
Method used to get the role for a specific user and project.

param: integer $usr_id The user ID
param: integer $prj_id The project ID
return: integer The role ID

getDetails($usr_id)   X-Ref
Method used to get the account details of a specific user.

param: integer $usr_id The user ID
return: array The account details

getFullName($usr_id)   X-Ref
Method used to get the full name of the specified user.

param: integer $usr_id The user ID
return: string The user' full name

getEmail($usr_id)   X-Ref
Method used to get the email address of the specified user.

param: integer $usr_id The user ID or user ids
return: string The user' full name

getGroupID($usr_id)   X-Ref
Method used to get the group id of the specified user.

param: integer $usr_id The user ID
return: string The user' full name

getStatusByEmail($email)   X-Ref
Returns the status of the user associated with the given email address.

param: string $email The email address
return: string The user status

changeStatus()   X-Ref
Method used to change the status of users, making them inactive
or active.

return: boolean

updatePassword($usr_id, $send_notification = FALSE)   X-Ref
Method used to update the account password for a specific user.

param: integer $usr_id The user ID
param: boolean $send_notification Whether to send the notification email or not
return: integer 1 if the update worked, -1 otherwise

updateFullName($usr_id)   X-Ref
Method used to update the account full name for a specific user.

param: integer $usr_id The user ID
return: integer 1 if the update worked, -1 otherwise

updateEmail($usr_id)   X-Ref
Method used to update the account email for a specific user.

param: integer $usr_id The user ID
return: integer 1 if the update worked, -1 otherwise

update()   X-Ref
Method used to update the account details for a specific user.

return: integer 1 if the update worked, -1 otherwise

insert()   X-Ref
Method used to add a new user to the system.

return: integer 1 if the update worked, -1 otherwise

getList($show_customers)   X-Ref
Method used to get the list of users available in the system.

param: boolean $show_customers Whether to return customers or not
return: array The list of users

getAssocEmailList()   X-Ref
Method used to get an associative array of the user's email address and
user ID.

return: array The list of users

getAssocList()   X-Ref
Method used to get an associative array of the user ID and
full name of the users available in the system.

return: array The list of users

getNameEmail($usr_id)   X-Ref
Method used to get the full name and email for the specified
user.

param: integer $usr_id The user ID
return: array The email and full name

getFromHeader($usr_id)   X-Ref
Method used to get the appropriate 'From' header for a
specified user.

param: integer $usr_id The user ID
return: string The formatted 'From' header

getClockedInList()   X-Ref
Returns the list of all users who are currently marked as
clocked-in.

return: array The list of clocked-in users

clockIn($usr_id)   X-Ref
Marks a user as clocked in.

param: int $usr_id The id of the user to clock out.

clockOut($usr_id)   X-Ref
Marks a user as clocked out.

param: integer $usr_id The id of the user to clock out.

isClockedIn($usr_id)   X-Ref
Returns true if a user is clocked in.

param: integer $usr_id The id of the user to clock out.
return: boolean True if the user is logged in, false otherwise

setGroupID($usr_id, $grp_id)   X-Ref
Sets the group ID

param: integer $usr_id The id of the user.
param: integer $grp_id The id of the group.

getLang($usr_id, $force_refresh = false)   X-Ref
No description

setLang($usr_id, $language)   X-Ref
No description

setLocalizedRoles()   X-Ref
No description



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7