3.5.2.15. User

File: classes/User.php
The User class provides support for users.

3.5.2.15.1. add_email
Format: result = add_email(uid,site,email)
where "uid" is the user ID, "site" is the site, and "email" is email to associate with that user.
Example: $result = $users->add_email($uid,$site,$email);

This method adds an email to the specified user.

3.5.2.15.2. Add_Logging
Format: result = Add_Logging(text)
where "text" is the text to log.
Example: $result = $users->Add_Logging($t);

This method logs some text associated with the site/user.

3.5.2.15.3. Add_Privilege
Format: result = Add_Privilege(uid,priv,mod,site)
where "uid" is the user ID, "site" is the site, "mod" is the module, and "priv" is the privilege to add to the user.
Example: $result = $users->Add_Privilege($uid,$priv,$mod,$site);

This method logs some text associated with the site/user.

3.5.2.15.4. Add_Whitelist
Format: result = Add_Whitelist(uid,siteid,ip)
where "uid" is the user ID, "siteid" is the site, and "ip" is an IP address.
Example: $result = $users->Add_Whitelist($uid,$siteid,$ip);

This method adds the specified IP address to the specified user's whitelist.

3.5.2.15.5. Any_Users
Format: result = Any_Users(site)
where "site" is the site in question.
Example: $result = $users->Any_Users($site);

This method returns true if the specified site has any users.

3.5.2.15.6. Change_Password
Format: result = Change_Password(name, password, site)
where "name" is the user account name, "site" is the site in question, and "password" is the new password.
Example: $result = $users->Change_Password($name, $password, $site);

This method sets the password of the specified user.

3.5.2.15.7. Clear_Context
Format: result = Clear_Context()
Example: $result = $users->Clear_Context();

This method clears the current user context.

3.5.2.15.8. Count_With_Privilege
Format: result = Count_With_Privilege(priv,module,site=0)
where "priv" is the privilege to check, "module" is an optional module to check, and "site" is the site.
Example: $result = $users->Count_With_Privilege($priv,0,$site);

This method returns the number of users on the specified site with the specified password.

3.5.2.15.9. Create_User
Format: result = Create_User(name, password, email, site)
where "name" is the name of the new user, "password" is the password, "email" is the initial email, and "site" is the site for the new user.
Example: $result = $users->Create_User($name, $password, $email, $site);

This method creates a new user.

3.5.2.15.10. Delete
Format: result = Delete(uid,site)
where "site" is the site and "site" is the site.
Example: $result = $users->Delete($uid,$site);

This method deletes the specified user.

3.5.2.15.11. Do_Call
Format: result = Do_Call(url)
where "url" is the URL to call.
Example: $result = $users->Do_Call($url);

This method calls to another page.

3.5.2.15.12. Do_Return
Format: result = Do_Return(default)
where "url" is the URL to call.
Example: $result = $users->Do_Return($default);

This method returns from a call to another page.

3.5.2.15.13. drop_email
Format: result = drop_email(uid,site,email)
where "uid" is the user ID, "site" is the site, and "email" is the email address to remove from the user.
Example: $result = $users->drop_email($uid,$site,$email);

This method removes the specified email from the specified user.

3.5.2.15.14. Drop_Privilege
Format: result = Drop_Privilege(uid,privilege,module,site)
where "uid" is the user ID, "site" is the site, "module" is the optional module, and "privilege" is the privilege to remove from the user. email address to remove from the user.
Example: $result = $users->Drop_Privilege($uid,$priv,$mod,$site);

This method removes the specified privilege from the specified user.

3.5.2.15.15. Get_All_Privilege_Names
Format: result = Get_All_Privilege_Names(language,module)
where "language" is the language to use and "module" is the optional module.
Example: $result = $users->Get_All_Privilege_Names($lang,$module);

This method returns the names of all privileges for the specified module (0=EWE). The names will be returned in the requested language. If the names are not available in that language, the default (English) names are returned.

3.5.2.15.16. get_info
Format: result = get_info(uid,siteid)
where "uid" is the user "siteid" is the site.
Example: $result = $users->get_info($uid,$siteid);

This method returns an array of information about the specified user.

3.5.2.15.17. Get_Name_From_ID
Format: result = Get_Name_From_ID(uid,site)
where "uid" is the user and "site" is the site.
Example: $result = $users->Get_Name_From_ID($uid,$site);

This method returns the user name of the specified user.

3.5.2.15.18. Get_User
Format: result = Get_User(uid,site)
where "uid" is the user and "site" is the site.
Example: $result = $users->Get_User($uid,$site);

This method returns an array of information about the specified user.

3.5.2.15.19. Get_User_By_ID
Format: result = Get_User_By_ID(uid, site)
where "uid" is the user and "site" is the site.
Example: $result = $users->Get_User_By_ID($uid, $site);

This method returns an array of information about the specified user.

3.5.2.15.20. Get_User_Count
Format: result = Get_User_Count(site)
where "site" is the site.
Example: $result = $users->Get_User_Count($site);

This method returns the number of users on the specified site.

3.5.2.15.21. Get_User_Name
Format: result = Get_User_Name(uid,site)
where "uid" is the user and "site" is the site.
Example: $result = $users->Get_User_Name($uid,$site);

This method returns the account name for the specified user.

3.5.2.15.22. Get_Users
Format: result = Get_Users(name, site)
where "name" is the user or "*" and "site" is the site.
Example: $result = $users->Get_Users($name, $site);

This method returns an array of users matching the specified name on the specified site. Each element is an array of information about a user.

3.5.2.15.23. Get_Whitelist
Format: result = Get_Whitelist(siteid,uid)
where "siteid" is the site and "uid" is the user.
Example: $result = $users->Get_Whitelist($siteid,$uid);

This method returns an array of IP addresses that is the whitelist for the specified user.

3.5.2.15.24. Has_Privilege
Format: result = Has_Privilege(uid,privilege,module,site)
where "site" is the site, "uid" is the user, "privilege" is the privilege to check, and "module" is the module.
Example: $result = $users->Get_Whitelist($siteid,$uid);

This method returns an array of IP addresses that is the whitelist for the specified user.

3.5.2.15.25. Log
Format: result = Log(text)
where "text" is the text to log.
Example: $result = $users->Log($t);

This method logs the specified text.

3.5.2.15.26. Login
Format: result = Login(name, password, site, cookie)
where "name" is the user name, "password" is the user's password, "site" is the site, and "cookie" is True to save a cookie on successful login, or false otherwise.
Example: $result = $users->Login($name, $password, $site, $cookie);

This method logs the user in. If the login fails, an error is returned.

3.5.2.15.27. Logout
Format: result = Logout(site=0)
where "name" is the user name, "password" is the user's password, "site" is the site, and "site" is the site.
Example: $result = $users->Logout($site);

This method logs the user out.

3.5.2.15.28. Pop_Context
Format: result = Pop_Context()
Example: $result = $users->Pop_Context();
This method pops a context off of the context stack. This is used with Do_Call and Do_Return.

3.5.2.15.29. Push_Context
Format: result = Push_Context(url)
where "url" is the page url to push.
Example: $result = $users->Push_Context($url);
This method pops a context off of the context stack. This is used with Do_Call and Do_Return.

3.5.2.15.30. Remove_Logging
Format: result = Remove_Logging(text)
where "text" is the text to log.
Example: $result = $users->Remove_Logging($message);
This method pops a context off of the context stack. This is used with Do_Call and Do_Return.

3.5.2.15.31. Remove_Whitelist
Format: result = Remove_Whitelist(siteid,uid,ID)
where "siteid" is the site, "uid" is the user, and "ID" is the whitelist ID to remove.
Example: $result = $users->Remove_Whitelist($siteid,$uid,$id);
This method removes the specified item from the whitelist.

3.5.2.15.32. resolve_user
Format: result = resolve_user(user,site)
where "site" is the site, "user" is the user name, email, or ID.
Example: $result = $users->resolve_user($u,$site);
This method returns the uid that matches the passed user.

3.5.2.15.33. Set_Name
Format: result = Set_Name(uid,site,name)
where "site" is the site, "uid" is the user, and "name" is the new account name.
Example: $result = $users->Set_Name($uid,$site,$name);
This method changes the name of the specified user.

3.5.2.15.34. update_info
Format: result = update_info(siteid,uid,item,value)
where "siteid" is the site, "uid" is the user, "item" is the item to update, and "value" is the new value for the item.
Example: $result = $users->update_info($siteid,$uid,$i,$t);
This method updates the information associated with the user.

3.5.2.15.35. User_ID
Format: result = User_ID(site=0)
where "site" is the site.
Example: $result = $users->User_ID($site);
This method returns the user ID for the current user and the specified site. -1 is returned if the user is not logged into the site.

3.5.2.15.36. User_Site
Format: result = User_Site(site=0)
where "site" is the site.
Example: $result = $users->User_Site($site);
This method returns the site ID for the current user, or -1 if the user is not logged into the specified site.

3.5.2.15.37. username
Format: result = username(site=0)
where "site" is the site.
Example: $result = $users->username($site);
This method returns the site username for the current user on the specified site.

3.5.2.15.38. Validate_Email
Format: result = Validate_Email(email)
where "email" is the email to validate.
Example: $result = $users->Validate_Email($v);
This method returns True if the passed value is a valid email address, or false otherwise. Not that this does not verify that email exists - only that it has the proper syntax.

3.5.2.15.39. Whitelisted_IP
Format: result = Whitelisted_IP(siteid,uid)
where "siteid" is the site and "uid" is the user.
Example: $result = $users->Whitelisted_IP($siteid,$uid);
This method returns True if the current IP matches a whitelisted IP.

3.5.2.15.40. Write_Log
Format: result = Write_Log(site,module,text,err,sql,event=0)
where "site" is the site, "module" is the module, "text" is the text to log, "err" is supplemental text, "sql" is an additional text to log, and "event" is the event type.
Example: $result = $users->Write_Log($site,$module,$t,$err,$sql,0);
This method logs a message. The text is logged, with an additional line of err (if provided), and then an additional line of sql (if provided). The standard is to log text that describes the error, with err as the underlying error code, and sql as the SQL statement that caused the error.