Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaTools Class Reference
Inheritance diagram for tariqaTools:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 ldapSearch ($token, $name, $max_time, $max_results)
 ldapFullSearch ($token, $filter, $max_time, $max_results)
 sendMail ($to, $sujet, $contenu, $attachments, $cc, $bcc)
 fetchUrl ($token, $request)
 fetchRSS ($token, $url, $first=null, $count=null)
 GetNymexQuotations ($token)
 ListCrisisRoomUsers ($token)
 ListAdvancedSearchSources ($token)

Data Fields

 $soap

Protected Member Functions

 _fetchUrl ($request)
 _fetchUrlNoProxy ($request)

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_fetchUrl ( request) [protected]

Fetch a document from the internet

Parameters:
WebRequest$requestHTTP query
Returns:
WebDocument protected
_fetchUrlNoProxy ( request) [protected]

Fetch a document from the intranet

Parameters:
WebRequest$requestHTTP query
Returns:
WebDocument protected
fetchRSS ( token,
url,
first = null,
count = null 
)

Retrieve the content of an RSS feed

Parameters:
string$tokenSession Identifier
string$urlUrl of the feed
int$firstThe first article to fetch [OPTIONAL]
int$countThe number of articles to fetch [OPTIONAL]
Returns:
Channel The Rss Feed's channel and articles
fetchUrl ( token,
request 
)

Fetch a document from the internet

Parameters:
string$tokenSession identifier
WebRequest$requestHTTP query
Returns:
WebDocument
GetNymexQuotations ( token)

Gets the nymex market share quotations

Parameters:
string$tokenThe session identifier
Returns:
NymexQuotation[]
ldapFullSearch ( token,
filter,
max_time,
max_results 
)

Search the Commission's LDAP database

Parameters:
string$tokenSession Identifier
string$filterLDAP Query
int$max_timeMaximum duration of the LDAP request in seconds [OPTIONAL]
int$max_resultsMaximum number of entries returned by the query [OPTIONAL]
Returns:
LDAPResultSet
ldapSearch ( token,
name,
max_time,
max_results 
)

Search the Commission's LDAP database by name or user id

Parameters:
string$tokenSession Identifier
string$nameA portion of the name to search (if not including any wildcards ('*') characters, it will be automatically appended AT THE END of the name)
int$max_timeMaximum duration of the LDAP request in seconds [OPTIONAL]
int$max_resultsMaximum number of entries returned by the query [OPTIONAL]
Returns:
LDAPResultSet

Lists the sources for the advanced search

Parameters:
string$tokenThe token identifier public
Returns:
AdvancedSearch[]
ListCrisisRoomUsers ( token)

List the crisis room users

Parameters:
string$tokenThe session identifier
Returns:
string[]
sendMail ( to,
sujet,
contenu,
attachments,
cc,
bcc 
)

Send an e-mail message to a list of recipients

Parameters:
string[]$to
string$sujet
string$contenu
Attachment[]$attachments [OPTIONAL]
string[]$cc List of recipients (Carbon copy) [OPTIONAL]
string[]$bcc List of recipients (Blind carbon copy) [OPTIONAL]
Returns:
boolean

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


The documentation for this class was generated from the following file: