Tariqa SOAP
|
Public Member Functions | |
fault ($code, $message) | |
__construct () | |
__call ($name, $arguments) | |
Data Fields | |
$soap | |
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" |
const | e_lexis = 0x6001 |
const | e_lexis_msg = "Your search would return more than 3000 documents!" |
const | NO_ACCESS_CHECK = -1 |
const | ACLK_ZERO = 0 |
const | ACLK_LEXISNEXIS = 1 |
const | ACLK_OXFORDANALYTICA = 2 |
const | ACLK_FACTIVA = 3 |
const | ACLK_GOOGLE = 4 |
const | ACLK_GLOBALATLAS = 4 |
const | ACLK_VIDEOARCHIVE = 5 |
const | ACLK_AGG_LATESTNEWS = 6 |
const | ACLK_AGG_RSS = 7 |
const | ACLK_LATESTNEWS = 8 |
const | ACLK_COMREF = 9 |
const | ACLK_WIKIPEDIA = 10 |
const | ACLK_VIRAGE = 11 |
const | ACLK_NYMEX = 12 |
const | ACLK_PERMANENCE = 13 |
const | ACLK_YAHOO = 14 |
const | ACLK_IDOL = 15 |
Protected Member Functions | |
OpenDatabase ($dsn, &$error) | |
dump_to_log (&$var) | |
CheckToken ($token) | |
CheckAccess ($token, $level) | |
GetRequiredAccessLevel ($ACLK) | |
_CheckAccess ($token, $level) | |
_GetUserVariable ($user_id, $key, $persistent=false) | |
Protected Attributes | |
$config = null |
__construct | ( | ) |
__call | ( | $ | name, |
$ | arguments | ||
) |
Calls the SOAP service functions
string | $name | The function name |
string[] | $arguments The function arguments public |
_CheckAccess | ( | $ | token, |
$ | level | ||
) | [protected] |
Checks the validity of a token
string | $token | The session identifier |
_GetUserVariable | ( | $ | user_id, |
$ | key, | ||
$ | persistent = false |
||
) | [protected] |
Fetch the value of a variable saved either in the user's session either in his/herpersistent storage
string | $user_id | The user identifier |
string | $key | The variable name (255 characters max) |
boolean | $persistent | If false (default) look for the value in the session, otherwise look in the persistent data of the user |
CheckAccess | ( | $ | token, |
$ | level | ||
) | [protected] |
Checks the validity of the token and the access level of the SOAP login used
string | $token | The session identifier |
int | $level | The requested access level |
CheckToken | ( | $ | token | ) | [protected] |
Checks the validity of a token
string | $token | The session identifier |
dump_to_log | ( | &$ | var | ) | [protected] |
Dump a variable's content into the PHP log
mixed | $var | protected |
fault | ( | $ | code, |
$ | message | ||
) |
Reimplements the fault function
int | $code | The fault code |
string | $message | The fault message public |
GetRequiredAccessLevel | ( | $ | ACLK | ) | [protected] |
Gets the required access level
int | $ACLK | The access level identifier protected |
OpenDatabase | ( | $ | dsn, |
&$ | error | ||
) | [protected] |
Establish a connection with the database
string | $dsn | Name of the database as defiend in the config file |
string | $error | Target variable for the error message |
$config = null [protected] |
Reimplemented in tariqaAggregator, tariqaBuzztracker, tariqaCountry, tariqaFactiva, tariqaQueriesAndSources, tariqaRadioTV, tariqaThemes, tariqaTools, tariqaAtlas, tariqaDelegations, tariqaGoogle, tariqaHotspots, tariqaIDOL, tariqaLatestNews, tariqaLexisNexis, tariqaNewsletter, tariqaOxfordAnalytica, tariqaSession, tariqaStaticUsers, tariqaVideoArchive, tariqaVirage, tariqaYahoo, and tariqaWikipediaCountryProfile.
$soap |
Reimplemented in tariqaAggregator, tariqaBuzztracker, tariqaCountry, tariqaFactiva, tariqaQueriesAndSources, tariqaRadioTV, tariqaThemes, tariqaTools, tariqaAtlas, tariqaDelegations, tariqaGoogle, tariqaHotspots, tariqaIDOL, tariqaLatestNews, tariqaLexisNexis, tariqaNewsletter, tariqaOxfordAnalytica, tariqaSession, tariqaStaticUsers, tariqaVideoArchive, tariqaVirage, tariqaYahoo, and tariqaWikipediaCountryProfile.
const ACLK_AGG_LATESTNEWS = 6 |
const ACLK_AGG_RSS = 7 |
const ACLK_COMREF = 9 |
const ACLK_FACTIVA = 3 |
const ACLK_GLOBALATLAS = 4 |
const ACLK_GOOGLE = 4 |
const ACLK_IDOL = 15 |
const ACLK_LATESTNEWS = 8 |
const ACLK_LEXISNEXIS = 1 |
const ACLK_NYMEX = 12 |
const ACLK_OXFORDANALYTICA = 2 |
const ACLK_PERMANENCE = 13 |
const ACLK_VIDEOARCHIVE = 5 |
const ACLK_VIRAGE = 11 |
const ACLK_WIKIPEDIA = 10 |
const ACLK_YAHOO = 14 |
const ACLK_ZERO = 0 |
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_lexis = 0x6001 |
Error code/message - LexisNexis - too many results error
const e_lexis_msg = "Your search would return more than 3000 documents!" |
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" |
const NO_ACCESS_CHECK = -1 |