Class tariqaOxfordAnalytica

Description

Located in /Tariqa.code/tariqaOxfordAnalytica.class.php (line 2)

Tariqa
   |
   --tariqaOxfordAnalytica
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
string[] oxanAuthenticate (string $token)
string oxanCountryProfileURL (Country $country)
OxfordAnalyticaDocument oxanFetchDocument (string $token, string $documentId)
OxfordAnalyticaDocument oxanFetchUrl (string $token,  $relative_url, string $documentId)
string oxanGateway (string $oxan_url)
MultiPair[] oxanGetStaticCountryList ()
MultiPair[] oxanGetStaticTopicList ()
OxfordAnalyticaSearchResult oxanSearch (string $token, [OxfordAnalyticaSimpleQuery|null $simpleQuery = null], [OxfordAnalyticaDetailedQuery|null $detailedQuery = null])
Variables
array $config = null (line 7)

Configuration array

  • access: protected
boolean $soap (line 13)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 20)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
oxanAuthenticate (line 31)

Authenticate with Oxford Analytica

  • return: The oxan cookies
  • access: protected
string[] oxanAuthenticate (string $token)
  • string $token: Session Identifier
oxanCountryProfileURL (line 249)

Get the URL of a Country Profile page

NOTES: Oxford Analytica is setup to accept access to its data from Tarîqa users No token is required here, as the user will neeed to be authenticated into Tarîqa to be able to proceed!

  • access: public
string oxanCountryProfileURL (Country $country)
  • Country $country: Country descriptor
oxanDetailedSearch (line 237)

Search Oxford Analytica

  • access: public
OxfordAnalyticaSearchResult oxanDetailedSearch (string $token, OxfordAnalyticaDetailedQuery $query)
oxanFetchDocument (line 164)

Fetch a document from the Oxford Analytica engine

  • access: public
OxfordAnalyticaDocument oxanFetchDocument (string $token, string $documentId)
  • string $token: Session Identifier
  • string $documentId: The Oxan document identifier
oxanFetchUrl (line 196)

Fetch a document from the Oxford Analytica engine

  • access: public
OxfordAnalyticaDocument oxanFetchUrl (string $token,  $relative_url, string $documentId)
  • string $token: Session Identifier
  • string $documentId: The Oxan document identifier
  • $relative_url
oxanGateway (line 265)

This function will transform oxan urls into tariqa urls suitable for the oxan special logon mechanism mechanism

NOTES: Oxford Analytica is setup to accept access to its data from Tarîqa users No token is required here, as the user will neeed to be authenticated into Tarîqa to be able to proceed!

  • return: The Tariqa url
  • access: public
string oxanGateway (string $oxan_url)
  • string $oxan_url: The Oxford Analytica URL
oxanGetStaticCountryList (line 427)

Get the "static" list of countries as defined in Oxford Analytica documentation

  • access: public
MultiPair[] oxanGetStaticCountryList ()
oxanGetStaticTopicList (line 503)

Get the "static" list of topics as defined in Oxford Analytica documentation

  • access: public
MultiPair[] oxanGetStaticTopicList ()
oxanParsePage (line 92)

Parse a page from Oxford Analytica

  • access: protected
OxfordAnalyticaDocument oxanParsePage (string $html)
  • string $html: The html page
oxanSearch (line 276)

Runs a search amongst OxfordAnalytica articles

  • access: protected
OxfordAnalyticaSearchResult oxanSearch (string $token, [OxfordAnalyticaSimpleQuery|null $simpleQuery = null], [OxfordAnalyticaDetailedQuery|null $detailedQuery = null])
oxanSimpleSearch (line 227)

Search Oxford Analytica

  • access: public
OxfordAnalyticaSearchResult oxanSimpleSearch (string $token, OxfordAnalyticaSimpleQuery $query)

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