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

Public Member Functions

 __construct ($config, $soap)
 oxanFetchDocument ($token, $documentId)
 oxanFetchUrl ($token, $relative_url)
 oxanSimpleSearch ($token, $query)
 oxanDetailedSearch ($token, $query)
 oxanCountryProfileURL ($country)
 oxanGateway ($oxan_url)
 oxanGetStaticCountryList ()
 oxanGetStaticTopicList ()

Data Fields

 $soap

Protected Member Functions

 oxanAuthenticate ($token)
 oxanParsePage ($html)
 oxanSearch ($token, $simpleQuery=null, $detailedQuery=null, $advancedQuery=null)

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

oxanAuthenticate ( token) [protected]

Authenticate with Oxford Analytica

Parameters:
string$tokenSession Identifier
Returns:
string[] The oxan cookies
oxanCountryProfileURL ( country)

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!

Parameters:
Country$countryCountry descriptor
Returns:
string
oxanDetailedSearch ( token,
query 
)

Search Oxford Analytica

Parameters:
string$tokenSession Identifier
OxfordAnalyticaDetailedQuery$query
Returns:
OxfordAnalyticaSearchResult
oxanFetchDocument ( token,
documentId 
)

Fetch a document from the Oxford Analytica engine

Parameters:
string$tokenSession Identifier
string$documentIdThe Oxan document identifier
Returns:
OxfordAnalyticaDocument
oxanFetchUrl ( token,
relative_url 
)

Fetch a document from the Oxford Analytica engine

Parameters:
string$tokenSession Identifier
string$documentIdThe Oxan document identifier
Returns:
OxfordAnalyticaDocument
oxanGateway ( oxan_url)

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!

Parameters:
string$oxan_urlThe Oxford Analytica URL
Returns:
string The Tariqa url

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

Returns:
MultiPair[]

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

Returns:
MultiPair[]
oxanParsePage ( html) [protected]

Parse a page from Oxford Analytica

Parameters:
string$htmlThe html page
Returns:
OxfordAnalyticaDocument
oxanSearch ( token,
simpleQuery = null,
detailedQuery = null,
advancedQuery = null 
) [protected]

Runs a search amongst OxfordAnalytica articles

Parameters:
string$tokenSession Identifier
OxfordAnalyticaSimpleQuery|nullSimple query or null if detailed query is used
OxfordAnalyticaDetailedQuery|nullDetailed query or null if simple query is used
OxfordAnalyticaAdvancedQuery|nullAdvanced query or null if other query is used
Returns:
OxfordAnalyticaSearchResult
oxanSimpleSearch ( token,
query 
)

Search Oxford Analytica

Parameters:
string$tokenSession Identifier
OxfordAnalyticaSimpleQuery$query
Returns:
OxfordAnalyticaSearchResult

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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