Class Tariqa

Description

Tarîqa SOAP Server Class

Located in /Tariqa.class.php (line 28)

SoapServer
   |
   --Tariqa
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
boolean $soap
Method Summary
void dump_to_log ( &$var, mixed $var)
boolean OpenDatabase (string $dsn,  &$error, string $error)
string __call (string $name, string[] $arguments)
Variables
array $config = null (line 34)

Configuration array

  • access: protected
boolean $soap (line 40)

The class is called using SOAP

  • access: public
Methods
dump_to_log (line 226)

Dump a variable's content into the PHP log

  • access: protected
void dump_to_log ( &$var, mixed $var)
  • mixed $var
  • &$var
Constructor __construct (line 46)

Constructs a Tariqa Object

  • access: public
Tariqa __construct ()
OpenDatabase (line 109)

Establish a connection with the database

  • access: protected
boolean OpenDatabase (string $dsn,  &$error, string $error)
  • string $dsn: Name of the database as defiend in the config file
  • string $error: Target variable for the error message
  • &$error
__call (line 240)

Calls the SOAP service functions

  • access: public
string __call (string $name, string[] $arguments)
  • string $name: The function name
  • string[] $arguments: The function arguments
Class Constants
e_account_locked = 0x1002 (line 156)

Error message - User account is locked

e_account_locked_msg = "User account locked" (line 157)
e_config = 0x1011 (line 180)

Error message - Invalid Configuration File

e_config_msg = "Invalid Configuration" (line 181)
e_database = 0x1021 (line 186)

Error message - Database error

e_database_msg = "Database error" (line 187)
e_forbidden = 0x1005 (line 174)

Error message - Forbidden access

e_forbidden_msg = "Access Forbidden" (line 175)
e_http = 0x2001 (line 204)

Error code/message - HTTP Error

e_http404 = 0x2002 (line 210)

Error code/message - HTTP 404 Error

e_http404_msg = "Not found" (line 211)
e_http_msg = "HTTP Error" (line 205)
e_internal_error = 0x0001 (line 132)

Error code/message - Internal Server Error

e_internal_error_msg = "Internal Server Error" (line 133)
e_invalid_argument = 0x0002 (line 138)

Error code/message - Invalid/Missing argument

e_invalid_argument_msg = "Invalid/Missing argument" (line 139)
e_invalid_format = 0x1031 (line 198)

Error code/message - Invalid format

e_invalid_format_msg = "Invalid file format" (line 199)
e_login = 0x1001 (line 150)

Error code/message - Invalid login

e_login_msg = "Invalid Username/Password" (line 151)
e_missing_record = 0x1022 (line 192)

Error message - Record not found

e_missing_record_msg = "Database record not found" (line 193)
e_not_implemented = 0x0003 (line 144)

Error code/message - Not implemented

e_not_implemented_msg = "Not implemented" (line 145)
e_privilege = 0x1004 (line 168)

Error message - Insufficient privileges

e_privilege_msg = "Insufficient privileges" (line 169)
e_session = 0x1003 (line 162)

Error message - Invalid Token/Session Identifier

e_session_msg = "Invalid Session Identifier" (line 163)
e_smtp = 0x3001 (line 216)

Error code/message - SMTP Error

e_smtp_msg = "SMTP Error" (line 217)

Documentation generated on Thu, 10 Dec 2009 15:21:42 +0100 by phpDocumentor 1.4.1