Class TariqaAuthentication

Description

Tarîqa SOAP Authentication Server Class

Located in /TariqaAuthentication.class.php (line 17)

SoapServer
   |
   --TariqaAuthentication
Class Constant Summary
 e_account_locked = 0x1002
 e_account_locked_msg = "User account locked"
 e_config = 0x1011
 e_config_msg = "Invalid Configuration"
 e_database = 0x1021
 e_database_msg = "Database error"
 e_forbidden = 0x1005
 e_forbidden_msg = "Access Forbidden"
 e_http = 0x2001
 e_http404 = 0x2002
 e_http404_msg = "Not found"
 e_http_msg = "HTTP Error"
 e_internal_error = 0x0001
 e_internal_error_msg = "Internal Server Error"
 e_invalid_argument_msg = "Invalid/Missing argument"
 e_invalid_format = 0x1031
 e_invalid_format_msg = "Invalid file format"
 e_login = 0x1001
 e_login_msg = "Invalid Username/Password"
 e_missing_record = 0x1022
 e_missing_record_msg = "Database record not found"
 e_not_implemented_msg = "Not implemented"
 e_privilege = 0x1004
 e_privilege_msg = "Insufficient privileges"
 e_session = 0x1003
 e_session_msg = "Invalid Session Identifier"
 e_smtp = 0x3001
 e_smtp_msg = "SMTP Error"
Variable Summary
array $config
Method Summary
string|false CheckToken (string $token)
void CloseDatabase ()
UserDetails GetUserDetails (string $token)
boolean IsLoggedIn (string $token)
AuthenticationResponse Login (string $login, string $password)
boolean Logout (string $token)
boolean OpenDatabase ( &$error)
boolean SetPassword (string $token, string $oldPassword, string $newPassword)
boolean SetUserDetails (string $token, UserDetails $userDetails)
Variables
array $config = null (line 23)

Configuration array

  • access: protected
Methods
CheckToken (line 476)

Checks the validity of a token

  • return: Returns false on error, the userId in case of success
  • access: protected
string|false CheckToken (string $token)
  • string $token: The session identifier
CloseDatabase (line 464)

Closes the connection with the database

  • access: protected
void CloseDatabase ()
GetUserDetails (line 371)

Retrieve the user details

  • access: public
UserDetails GetUserDetails (string $token)
  • string $token: The session identifier
IsLoggedIn (line 287)

Checks if the session is valid

  • access: public
boolean IsLoggedIn (string $token)
  • string $token: The session identifier
Login (line 94)

Authenticates with TariqaSoap

  • return: An identification token and its expiry time
  • access: public
AuthenticationResponse Login (string $login, string $password)
  • string $login: The username
  • string $password: The password
Logout (line 297)

Logout from Tariqa Soap

  • access: public
boolean Logout (string $token)
  • string $token: The session identifier
OpenDatabase (line 441)

Establish a connection with the database

  • access: protected
boolean OpenDatabase ( &$error)
  • &$error
SetPassword (line 324)

Modify the user password

  • access: public
boolean SetPassword (string $token, string $oldPassword, string $newPassword)
  • string $token: The session identifier
  • string $oldPassword: The actual password
  • string $newPassword: The new password
SetUserDetails (line 404)

Modify the user details (Note that user_id and isAdministrator are READ-ONLY!)

  • access: public
boolean SetUserDetails (string $token, UserDetails $userDetails)
  • string $token: The session identifier
  • UserDetails $userDetails: (Please note that you can't modify the 'isAdministrator')
Class Constants
e_account_locked = 0x1002 (line 623)

Error message - User account is locked

e_account_locked_msg = "User account locked" (line 624)
e_config = 0x1011 (line 647)

Error message - Invalid Configuration File

e_config_msg = "Invalid Configuration" (line 648)
e_database = 0x1021 (line 653)

Error message - Database error

e_database_msg = "Database error" (line 654)
e_forbidden = 0x1005 (line 641)

Error message - Forbidden access

e_forbidden_msg = "Access Forbidden" (line 642)
e_http = 0x2001 (line 671)

Error code/message - HTTP Error

e_http404 = 0x2002 (line 677)

Error code/message - HTTP 404 Error

e_http404_msg = "Not found" (line 678)
e_http_msg = "HTTP Error" (line 672)
e_internal_error = 0x0001 (line 599)

Error code/message - Internal Server Error

e_internal_error_msg = "Internal Server Error" (line 600)
e_invalid_argument = 0x0002 (line 605)

Error code/message - Invalid/Missing argument

e_invalid_argument_msg = "Invalid/Missing argument" (line 606)
e_invalid_format = 0x1031 (line 665)

Error code/message - Invalid format

e_invalid_format_msg = "Invalid file format" (line 666)
e_login = 0x1001 (line 617)

Error code/message - Invalid login

e_login_msg = "Invalid Username/Password" (line 618)
e_missing_record = 0x1022 (line 659)

Error message - Record not found

e_missing_record_msg = "Database record not found" (line 660)
e_not_implemented = 0x0003 (line 611)

Error code/message - Not implemented

e_not_implemented_msg = "Not implemented" (line 612)
e_privilege = 0x1004 (line 635)

Error message - Insufficient privileges

e_privilege_msg = "Insufficient privileges" (line 636)
e_session = 0x1003 (line 629)

Error message - Invalid Token/Session Identifier

e_session_msg = "Invalid Session Identifier" (line 630)
e_smtp = 0x3001 (line 683)

Error code/message - SMTP Error

e_smtp_msg = "SMTP Error" (line 684)

Documentation generated on Mon, 30 Mar 2009 16:35:39 +0200 by phpDocumentor 1.4.1