Class tariqaTools

Description

Located in /Tariqa.code/tariqaTools.class.php (line 3)

Tariqa
   |
   --tariqaTools
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
Channel fetchRSS (string $token, string $url, [int $first = null], [int $count = null])
WebDocument fetchUrl (string $token, WebRequest $request)
NymexQuotation[] GetNymexQuotations (string $token)
LDAPResultSet ldapFullSearch (string $token, string $filter, int $max_time, int $max_results)
LDAPResultSet ldapSearch (string $token, string $name, int $max_time, int $max_results)
string[] ListCrisisRoomUsers (string $token)
boolean sendMail (string[] $to, string $sujet, string $contenu, Attachment[] $attachments, string[] $cc, string[] $bcc)
Variables
array $config = null (line 8)

Configuration array

  • access: protected
boolean $soap (line 14)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 21)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
fetchRSS (line 437)

Retrieve the content of an RSS feed

  • return: The Rss Feed's channel and articles
  • access: public
Channel fetchRSS (string $token, string $url, [int $first = null], [int $count = null])
  • string $token: Session Identifier
  • string $url: Url of the feed
  • int $first: The first article to fetch [OPTIONAL]
  • int $count: The number of articles to fetch [OPTIONAL]
fetchUrl (line 285)

Fetch a document from the internet

  • access: public
WebDocument fetchUrl (string $token, WebRequest $request)
  • string $token: Session identifier
  • WebRequest $request: HTTP query
GetNymexQuotations (line 514)

Gets the nymex market share quotations

  • access: public
NymexQuotation[] GetNymexQuotations (string $token)
  • string $token: The session identifier
ldapFullSearch (line 52)

Search the Commission's LDAP database

  • access: public
LDAPResultSet ldapFullSearch (string $token, string $filter, int $max_time, int $max_results)
  • string $token: Session Identifier
  • string $filter: LDAP Query
  • int $max_time: Maximum duration of the LDAP request in seconds [OPTIONAL]
  • int $max_results: Maximum number of entries returned by the query [OPTIONAL]
ldapSearch (line 34)

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

  • access: public
LDAPResultSet ldapSearch (string $token, string $name, int $max_time, int $max_results)
  • string $token: Session Identifier
  • string $name: A 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_time: Maximum duration of the LDAP request in seconds [OPTIONAL]
  • int $max_results: Maximum number of entries returned by the query [OPTIONAL]
ListCrisisRoomUsers (line 573)

List the crisis room users

  • access: public
string[] ListCrisisRoomUsers (string $token)
  • string $token: The session identifier
sendMail (line 109)

Send an e-mail message to a list of recipients

  • access: public
boolean sendMail (string[] $to, string $sujet, string $contenu, Attachment[] $attachments, string[] $cc, string[] $bcc)
  • 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]
_fetchUrl (line 143)

Fetch a document from the internet

  • access: protected
WebDocument _fetchUrl (WebRequest $request)
_fetchUrlNoProxy (line 313)

Fetch a document from the intranet

  • access: protected
WebDocument _fetchUrlNoProxy (WebRequest $request)

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