Tariqa
3.0
|
Public Member Functions | |
__construct () | |
__destruct () | |
Login ($login, $password) | |
IsLoggedIn ($token) | |
Logout ($token) | |
SetPassword ($token, $oldPassword, $newPassword) | |
GetUserDetails ($token) | |
SetUserDetails ($token, $userDetails) | |
Data Fields | |
const | e_internal_error = 0x0001 |
const | e_internal_error_msg = "Internal Server Error" |
const | e_invalid_argument = 0x0002 |
const | e_invalid_argument_msg = "Invalid/Missing argument" |
const | e_not_implemented = 0x0003 |
const | e_not_implemented_msg = "Not implemented" |
const | e_login = 0x1001 |
const | e_login_msg = "Invalid Username/Password" |
const | e_account_locked = 0x1002 |
const | e_account_locked_msg = "User account locked" |
const | e_session = 0x1003 |
const | e_session_msg = "Invalid Session Identifier" |
const | e_privilege = 0x1004 |
const | e_privilege_msg = "Insufficient privileges" |
const | e_forbidden = 0x1005 |
const | e_forbidden_msg = "Access Forbidden" |
const | e_config = 0x1011 |
const | e_config_msg = "Invalid Configuration" |
const | e_database = 0x1021 |
const | e_database_msg = "Database error" |
const | e_missing_record = 0x1022 |
const | e_missing_record_msg = "Database record not found" |
const | e_invalid_format = 0x1031 |
const | e_invalid_format_msg = "Invalid file format" |
const | e_http = 0x2001 |
const | e_http_msg = "HTTP Error" |
const | e_http404 = 0x2002 |
const | e_http404_msg = "Not found" |
const | e_smtp = 0x3001 |
const | e_smtp_msg = "SMTP Error" |
Protected Member Functions | |
OpenDatabase (&$error) | |
CloseDatabase () | |
CheckToken ($token) | |
Protected Attributes | |
$config = null |
Tarîqa SOAP Authentication Server Class
&wsdl Generates the WSDL http://localhost:81/soap/tools/wshelper/service.php?class=Tariqa View the documentation http://d02di0414709:81/soap/Tariqa?cli Run the demo application, open:
__construct | ( | ) |
Constructs a TariqaAuthentication object
__destruct | ( | ) |
Destructs the object
CheckToken | ( | $ | token | ) | [protected] |
Checks the validity of a token
string | $token | The session identifier |
CloseDatabase | ( | ) | [protected] |
Closes the connection with the database
GetUserDetails | ( | $ | token | ) |
IsLoggedIn | ( | $ | token | ) |
Checks if the session is valid
string | $token | The session identifier |
Login | ( | $ | login, |
$ | password | ||
) |
Authenticates with TariqaSoap
string | $login | The username |
string | $password | The password |
Logout | ( | $ | token | ) |
Logout from Tariqa Soap
string | $token | The session identifier |
OpenDatabase | ( | &$ | error | ) | [protected] |
Establish a connection with the database
SetPassword | ( | $ | token, |
$ | oldPassword, | ||
$ | newPassword | ||
) |
Modify the user password
string | $token | The session identifier |
string | $oldPassword | The actual password |
string | $newPassword | The new password |
SetUserDetails | ( | $ | token, |
$ | userDetails | ||
) |
Modify the user details (Note that user_id and isAdministrator are READ-ONLY!)
string | $token | The session identifier |
UserDetails | $userDetails | (Please note that you can't modify the 'isAdministrator') |
$config = null [protected] |
const e_account_locked = 0x1002 |
Error message - User account is locked
const e_account_locked_msg = "User account locked" |
const e_config = 0x1011 |
Error message - Invalid Configuration File
const e_config_msg = "Invalid Configuration" |
const e_database = 0x1021 |
Error message - Database error
const e_database_msg = "Database error" |
const e_forbidden = 0x1005 |
Error message - Forbidden access
const e_forbidden_msg = "Access Forbidden" |
const e_http = 0x2001 |
Error code/message - HTTP Error
const e_http404 = 0x2002 |
Error code/message - HTTP 404 Error
const e_http404_msg = "Not found" |
const e_http_msg = "HTTP Error" |
const e_internal_error = 0x0001 |
Error code/message - Internal Server Error
const e_internal_error_msg = "Internal Server Error" |
const e_invalid_argument = 0x0002 |
Error code/message - Invalid/Missing argument
const e_invalid_argument_msg = "Invalid/Missing argument" |
const e_invalid_format = 0x1031 |
Error code/message - Invalid format
const e_invalid_format_msg = "Invalid file format" |
const e_login = 0x1001 |
Error code/message - Invalid login
const e_login_msg = "Invalid Username/Password" |
const e_missing_record = 0x1022 |
Error message - Record not found
const e_missing_record_msg = "Database record not found" |
const e_not_implemented = 0x0003 |
Error code/message - Not implemented
const e_not_implemented_msg = "Not implemented" |
const e_privilege = 0x1004 |
Error message - Insufficient privileges
const e_privilege_msg = "Insufficient privileges" |
const e_session = 0x1003 |
Error message - Invalid Token/Session Identifier
const e_session_msg = "Invalid Session Identifier" |
const e_smtp = 0x3001 |
Error code/message - SMTP Error
const e_smtp_msg = "SMTP Error" |