Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
TariqaClient Class Reference

Public Member Functions

 __construct ($options=null, $config, $user)
 __call ($name, $arguments)
 latestNewsSearch ($token, $query, $range=null)
 latestNewsFetch ($token, $resultset, $first=null, $count=null)
 latestNewsGetDocument ($token, $id)
 fetchLatestNews ($token, $query, $range=null, $page_number=null, $page_size=null, $paginal=true)
 getLatestNewsArticle ($token, $id)
 GetAggregatedRSSFeed ($token, $feed_id)
 ListAggregatedRSSFeeds ($token)
 GetCountryAggregatedRSSFeeds ($token, $country)
 GetThemeAggregatedRSSFeeds ($token, $theme_id)
 GetAggregatedRSSArticle ($token, $article_id)
 ListAggregatedRSSArticles ($token, $feed_id=null, $time_range=null, $record_range_from=null, $record_range_no=null, $time_range_count=null)
 GetAggregatedRSSArticlesNumber ($token, $feed_id=null, $time_range=null, $time_range_count=null)
 GetCountryAggregatedRSSArticles ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null)
 GetCountryAggregatedRSSArticlesNumber ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null)
 GetThemeAggregatedRSSArticles ($token, $theme_id, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null)
 GetAggregatedLatestnewsFeed ($token, $feed_id)
 ListAggregatedLatestnewsFeeds ($token)
 GetAggregatedLatestnewsCountryFeeds ($token, $country)
 GetAggregatedLatestnewsThemeFeeds ($token, $theme_id)
 GetAggregatedLatestnewsArticle ($token, $article_id)
 ListAggregatedLatestnewsArticles ($token, $feed_id=null, $time_range=null, $record_range_from=null, $record_range_no=null, $time_range_count=null)
 GetAggregatedLatestnewsArticlesNumber ($token, $feed_id=null, $time_range=null, $time_range_count=null)
 GetAggregatedLatestnewsCountryArticlesNumber ($token, $country, $time_range=null, $time_range_count=null)
 GetAggregatedLatestnewsCountryArticles ($token, $country, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null)
 GetAggregatedLatestnewsThemeArticles ($token, $theme_id, $time_range=null, $time_range_count=null, $record_range_from=null, $record_range_no=null)
 CreateAggregatedRSSFeed ($token, $feed, $country, $theme)
 UpdateAggregatedRSSFeed ($token, $feed)
 DeleteAggregatedRSSFeed ($token, $feed_id)
 CreateAggregatedLatestnewsFeed ($token, $feed, $country, $theme)
 UpdateAggregatedLatestnewsFeed ($token, $feed)
 DeleteAggregatedLatestnewsFeed ($token, $feed_id)
 ListGlobalAtlasMaps ($token, $country, $dayRange=null)
 fetchBuzztracker ($token, $date)
 GetCountryMaps ($token, $country, $day_range)
 GetCountryStatisticsPerDay ($token, $countries, $startDate=null, $endDate=null)
 GetCountryStatisticsPerHour ($token, $countries, $date=null)
 listCountries ($token, $continent_id=null, $eu_members_only=null, $official_only=null, $region_id=null)
 listCountries2 ($token, $continent_id=null, $eu_members_only=null, $official_only=null)
 getCountry ($token, $iso2, $iso3, $isonum, $comref, $sysper, $iana, $ioc, $un, $itu, $oxan_id, $comref_del)
 listContinents ($token)
 getContinent ($token, $continent_id)
 getRegionList ($token, $level=null)
 listOfficialRegions ($token, $continent_id)
 listRegions ($token, $fetch_countries=null)
 getRegion ($token, $region_id)
 GetCluster ($token, $cluster_id)
 ListClusters ($token, $fetch_countries=null)
 GetReliefWebMaps ($token, $country_id)
 listDelegations ($token, $country)
 listDelegations2 ($token, $countries)
 getDelegation ($token, $delegation_id)
 getDelegationPersonnel ($token, $delegation_id)
 getHeadsOfDelegation ($token, $delegation_id)
 listCrisisCorrespondents ($token, $countries)
 getCrisisCorrespondent ($token, $country)
 FactivaContentSearch ($token, $query)
 factivaLoginGetControlData ()
 FactivaGetDocument ($token, $accessionNo)
 FactivaSourceSearch ($token, $query)
 FactivaSourceGroupSearch ($token, $query)
 googleSearch ($token, $query)
 googleFetch ($token, $resultset, $first=null, $count=null)
 ListHotSpots ($token, $day=null)
 LexisNexisSourceSearch ($token, $query)
 LexisNexisSearch ($token, $query)
 LexisNexisGetDocuments ($token, $searchId, $begin=1, $end=20)
 LexisNexisGetFullDocument ($token, $documentId)
 LexisNexisGetAttachments ($token, $attachmentId)
 LexisNexisBrowseSources ($token, $folderId=null)
 LexisNexisGetSortKeys ($token, $searchId)
 ListNewsletters ($token, $category_id=null)
 getNewsletter ($token, $newsletter_id)
 listIndarNewsletters ($token)
 getIndarNewsletter ($token, $newsletter_id)
 listNewslettersCategories ($token)
 getNewsletterCategory ($token, $category_id)
 canEditNewsletter ($token, $user_id, $newsletter_ids)
 canEditNewsletterCategory ($token, $user_id, $category_ids)
 saveNewsletter ($token, $newsletter)
 deleteNewsletter ($token, $newsletter_id)
 oxanFetchDocument ($token, $documentId)
 oxanFetchUrl ($token, $relative_url)
 oxanSimpleSearch ($token, $query)
 oxanDetailedSearch ($token, $query)
 oxanCountryProfileURL ($country)
 oxanGateway ($oxan_url)
 oxanGetStaticCountryList ()
 oxanGetStaticTopicList ()
 GetHomepageQueries ($token)
 GetVideoQueries ($token)
 ListQuickSearchSources ($token)
 GetSource ($token, $source_id)
 ListSources ($token)
 GetFlavour ($token, $flavour_id)
 ListFlavours ($token)
 _getEngine ($token, $engine_id)
 GetEngine ($token, $engine_id)
 ListEngines ($token)
 GetQuery ($token, $query_id, $get_source=false, $get_engine=false)
 ListQueries ($token)
 GetCountryQueries ($token, $country, $flavour_id=null)
 GetRegionQueries ($token, $region_id, $flavour_id=null)
 ListNewStickerGroups ($token)
 ListTVChannelsCategories ($token)
 ListTVChannels ($token, $category_id=null)
 ListRadioChannelsCategories ($token)
 ListRadioChannels ($token, $category_id=null)
 GetUserSessionVariable ($token, $key)
 GetUserPersistentVariable ($token, $key)
 SetUserSessionVariable ($token, $key, $value)
 SetUserPersistentVariable ($token, $key, $value)
 SetUserSessionVariables ($token, $variables)
 SetUserPersistentVariables ($token, $variables)
 GetUserSessionVariables ($token)
 GetUserPersistentVariables ($token)
 GetServerVariable ($token, $key)
 GetServerVariables ($token)
 SetServerVariables ($token, $variables)
 SetServerVariable ($token, $key, $value)
 ListSystemCachedUsers ($token, $department=null)
 GetSystemCachedUser ($token, $user_id)
 ListLDAPCachedDepartments ($token)
 GetTheme ($token, $theme_id)
 ListThemes ($token, $no_texts=false)
 SetThemeText ($token, $theme_id, $short_text, $long_text)
 GetThemeQueries ($token, $theme_id)
 SetThemeUserDefinedQuery ($token, $theme_id, $query)
 ListThemeTopics ($token, $theme_id)
 GetThemeTopic ($token, $topic_id)
 ListTopicQueries ($token, $topic_id)
 GetTopicQuery ($token, $topic_id, $query_id)
 ListThemeTopicsWithQueries ($token, $theme_id)
 ListThemeUsers ($token, $theme_id)
 DeleteThemeUserDefinedQuery ($token, $theme_id)
 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)
 listVideoArchiveChannels ($token, $channel=null, $start_date=null, $end_date=null, $title=null)
 listVideoArchiveRecords ($token, $first_record=null, $record_count=null, $channel=null, $start_date=null, $end_date=null, $title=null)
 countVideoArchiveRecords ($token, $channel=null, $start_date=null, $end_date=null, $title=null)
 VirageSearch ($token, $query)
 VirageSearch2 ($token, $query)
 VirageGetDocument ($token, $document_id, $getImages)
 VirageGetDocumentImages ($token, $document_id)
 GetWikipediaCountryProfile ($token, $country)
 ListAdvancedSearchSources ($token)
 VirageGetFullText ($token, $document_id, $document=null)
 VirageGetDocumentHeadlines ($token)
 VirageGetWords ($token, $document_id, $complete=true, $document=null)
 VirageGetDocumentAllImages ($token, $document_id, $type, $getContent, $cache, $document=null)

Data Fields

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"

Protected Member Functions

 _getCountry ($iso2=null, $iso3=null, $isonum=null, $comref=null, $sysper=null, $iana=null, $ioc=null, $un=null, $itu=null, $oxan_id=null, $comref_del=null)
 _googleSearch ($query)
 googleGetDocument ($token, $url)
 _listHotSpots ($day=null)
 _LexisNexisGetFullDocument ($documentId)
 _LexisNexisGetAttachments ($attachmentId)
 WSKAuthenticate ()
 WSKBrowseSources ($folderId=null)
 WSK2LN_BrowseSourcesResponse ($object, $folderId=null)
 oxanAuthenticate ($token)
 oxanParsePage ($html)
 oxanSearch ($token, $simpleQuery=null, $detailedQuery=null)
 CheckToken ($token)
 SetUserVariable ($token, $key, $value, $persistent=false)
 SetUserVariables ($token, $variables, $persistent=false)
 _GetServerVariable ($key)
 _SetServerVariable ($key, $value)
 _GetServerVariables ()
 _SetServerVariables ($variables)
 _fetchUrl ($request)
 _fetchUrlNoProxy ($request)
 videoArchiveBuildSQLQuery ($first_record=null, $record_count=null, $channel=null, $start_date=null, $end_date=null, $title=null)

Protected Attributes

 $retry = 0

Detailed Description

Class for using the SOAP service


Constructor & Destructor Documentation

__construct ( options = null,
config,
user 
)
Parameters:
array$optionsAn array of options to pass to the SoapClient constructor
array$configThe configuration array
tariqaUser$userThe ECAS user
Returns:
TariqaClient

Member Function Documentation

__call ( name,
arguments 
)

Calls a SOAP method

Parameters:
string$nameThe name of the method
array$argumentsThe arguments of the method public
Returns:
mixed
_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
_getCountry ( iso2 = null,
iso3 = null,
isonum = null,
comref = null,
sysper = null,
iana = null,
ioc = null,
un = null,
itu = null,
oxan_id = null,
comref_del = null 
) [protected]

Get the information about a country identified by a code

Parameters:
string$iso2ISO 3166(2 alpha) [OPTIONAL]
string$iso3ISO 3166(3 alpha) [OPTIONAL]
int$isonumISO 3166(numeric) [OPTIONAL]
string$comrefE.C. COMREF PriKey [OPTIONAL]
string$sysperE.C. SYSPER2 [OPTIONAL]
string$ianaInternet Assigned Numbers Authority [OPTIONAL]
string$iocInternational Olympic Committee [OPTIONAL]
string$unU.N. International Traffic Distinguished Signs [OPTIONAL]
string$ituI.T.U Codes for International Telephone calls [OPTIONAL]
string$oxan_idOxford Analytica's Country Name [OPTIONAL]
string$comref_delE.C. COMREF - Delegation Country ID (if it differs from $comref) [OPTIONAL]
Returns:
Country
_getEngine ( token,
engine_id 
)

Get the content of an engine without authentication

Parameters:
string$tokenThe session identifier
string$engine_idThe engine identifier
Returns:
Engine
_GetServerVariable ( key) [protected]

Fetch the value of a variable saved in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)

Parameters:
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable protected
_GetServerVariables ( ) [protected]

Fetch the list of server variables (WITHOUT CHECKING THE SESSION TOKEN)

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables protected
_googleSearch ( query) [protected]

Search for articles using Google News

Parameters:
string$tokenSession Identifier
GoogleQuery$queryQuery
Returns:
GoogleResultset
_LexisNexisGetAttachments ( attachmentId) [protected]

Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$attachmentIdAttachment ID
Returns:
LexisNexisAttachment[]
_LexisNexisGetFullDocument ( documentId) [protected]

Retrieve specific document in full text [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$documentIdDocument ID
Returns:
LexisNexisDocument
_listHotSpots ( day = null) [protected]

Get the list of hotspots for a day without authentification

Parameters:
int$dayThe day for which to retrieve the hotspots (null means the current date) [OPTIONAL]
Returns:
string[] A list of countries iso codes.
_SetServerVariable ( key,
value 
) [protected]

Save a variable in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)

Parameters:
string$tokenSession identifier
string$keyVariable name (255 characters max)
string$valueValue
Returns:
boolean protected
_SetServerVariables ( variables) [protected]

Set all server variables at once (WITHOUT CHECKING THE SESSION TOKEN)

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean protected
canEditNewsletter ( token,
user_id,
newsletter_ids 
)

Tells if an user can edit a newsletter

Parameters:
string$tokenThe session identifier
string$user_idThe user identifier
int[]$newsletter_ids An array of newsletter identifiers public
Returns:
int[]
canEditNewsletterCategory ( token,
user_id,
category_ids 
)

Tells if an user can edit a newsletter category

Parameters:
string$tokenThe session identifier
string$user_idThe user identifier
int[]$category_ids An array of newsletter categories identifiers public
Returns:
int[]
CheckToken ( token) [protected]

Checks the validity of a token

Parameters:
string$tokenThe session identifier
Returns:
string|false Returns false on error, the userId in case of success
countVideoArchiveRecords ( token,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Count the number of available Records from the video archive

Parameters:
string$tokenThe session identifier
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
int
CreateAggregatedLatestnewsFeed ( token,
feed,
country,
theme 
)

Creates a new Latestnews Feed

Parameters:
string$tokenThe session identifier
Latestnews_feed$feedThe new feed to be inserted in the database
Country$countryThe feed country (null if there is not a country for this feed)
Theme$themeThe feed theme (null if there is not a theme for this feed)
Returns:
boolean
CreateAggregatedRSSFeed ( token,
feed,
country,
theme 
)

Creates a new RSS Feed

Parameters:
string$tokenThe session identifier
RSS_feed$feedThe new feed to be inserted in the database
Country$countryThe feed country (null if there is not a country for this feed)
Theme$themeThe feed theme (null if there is not a theme for this feed)
Returns:
boolean
DeleteAggregatedLatestnewsFeed ( token,
feed_id 
)

Deletes a Latestnews Feed

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identificator
Returns:
boolean
DeleteAggregatedRSSFeed ( token,
feed_id 
)

Deletes a RSS Feed

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identificator
Returns:
boolean
deleteNewsletter ( token,
newsletter_id 
)

Deletes a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier public
Returns:
boolean
DeleteThemeUserDefinedQuery ( token,
theme_id 
)

Deletes a theme user defined query

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
boolean
FactivaContentSearch ( token,
query 
)

Search for articles using Factiva

Parameters:
string$tokenSession Identifier
FactivaContentQuery$queryThe factiva query
Returns:
FactivaContentResultSet
FactivaGetDocument ( token,
accessionNo 
)

Retrieve a factiva document

Parameters:
string$tokenSession Identifier
string$accessionNoThe document identifier
Returns:
FactivaDocument

Retrieve the control data from the session files

Returns:
factiva_LoginResultType
FactivaSourceGroupSearch ( token,
query 
)

Search for articles using Google News

Parameters:
string$tokenSession Identifier
FactivaSourceGroupQuery$queryThe factiva query
Returns:
FactivaSourceGroupResultSet
FactivaSourceSearch ( token,
query 
)

Search for sources using Factiva

Parameters:
string$tokenSession Identifier
FactivaSourceQuery$queryThe factiva query
Returns:
FactivaSourceResultSet
fetchBuzztracker ( token,
date 
)

Get the Buzztracker map of a given date

Parameters:
string$tokenSession identifier
int$dateThe date to fetch (unix format timestamp)
Returns:
string[] The First element of the array is the HTML imagemap, the second element is the list of major hotspots
fetchLatestNews ( token,
query,
range = null,
page_number = null,
page_size = null,
paginal = true 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
string$querySQL query
float$rangeTime range in days (you may use fractions!) [OPTIONAL]
int$page_numberWhich page of articles to fetch [OPTIONAL]
int$page_sizeHow many articles should be displayed on each page [OPTIONAL]
boolean$paginalIf set to true, the results are paginated, else page_number represents the first result, and page_size the number of results [OPTIONAL]
Returns:
Resultset
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
GetAggregatedLatestnewsArticle ( token,
article_id 
)

Get an article from Latestnews Aggregator

Parameters:
string$tokenThe session identifier
int$article_idThe article identifier
Returns:
Latestnews_article
GetAggregatedLatestnewsArticlesNumber ( token,
feed_id = null,
time_range = null,
time_range_count = null 
)

Get the number of available articles from Latestnews aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe number of days starting from time range (null means all articles) [OPTIONAL]
Returns:
int
GetAggregatedLatestnewsCountryArticles ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null 
)

Get the list of available latestnews articles for a country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
Returns:
Latestnews_article[]
GetAggregatedLatestnewsCountryArticlesNumber ( token,
country,
time_range = null,
time_range_count = null 
)

Get the number of available latestnews articles for a country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
Returns:
int
GetAggregatedLatestnewsCountryFeeds ( token,
country 
)

Get the list of available latestnews feeds for a selected country

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
Returns:
Latestnews_feed[]
GetAggregatedLatestnewsFeed ( token,
feed_id 
)

Get a feed from Latestnews Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier
Returns:
Latestnews_feed
GetAggregatedLatestnewsThemeArticles ( token,
theme_id,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null 
)

Get the list of available latestnews articles for a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
Returns:
RSS_article[]
GetAggregatedLatestnewsThemeFeeds ( token,
theme_id 
)

Get the list of available latestnews feeds for a selected theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
Returns:
Latestnews_feed[]
GetAggregatedRSSArticle ( token,
article_id 
)

Get an article from the RSS Aggregator

Parameters:
string$tokenThe session identifier
int$article_idThe article identifier
Returns:
RSS_article
GetAggregatedRSSArticlesNumber ( token,
feed_id = null,
time_range = null,
time_range_count = null 
)

Get the number of available articles from the Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
Returns:
int
GetAggregatedRSSFeed ( token,
feed_id 
)

Get a feed from RSS Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier
Returns:
RSS_feed
GetCluster ( token,
cluster_id 
)

Get the content of a cluster

Parameters:
string$tokenThe session identifier
int$cluster_idThe cluster identifier
Returns:
Cluster
getContinent ( token,
continent_id 
)

Get the information about a continent

Parameters:
string$tokenThe session identifier
int$continent_idId of the continent
Returns:
Continent
getCountry ( token,
iso2,
iso3,
isonum,
comref,
sysper,
iana,
ioc,
un,
itu,
oxan_id,
comref_del 
)

Get the information about a country identified by a code

Parameters:
string$tokenThe session identifier
string$iso2ISO 3166(2 alpha) [OPTIONAL]
string$iso3ISO 3166(3 alpha) [OPTIONAL]
int$isonumISO 3166(numeric) [OPTIONAL]
string$comrefE.C. COMREF PriKey [OPTIONAL]
string$sysperE.C. SYSPER2 [OPTIONAL]
string$ianaInternet Assigned Numbers Authority [OPTIONAL]
string$iocInternational Olympic Committee [OPTIONAL]
string$unU.N. International Traffic Distinguished Signs [OPTIONAL]
string$ituI.T.U Codes for International Telephone calls [OPTIONAL]
string$oxan_idOxford Analytica's Country Name [OPTIONAL]
string$comref_delE.C. COMREF - Delegation Country ID (if it differs from $comref) [OPTIONAL]
Returns:
Country
GetCountryAggregatedRSSArticles ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null 
)

Get the list of available articles for a country from the RSS Aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
Returns:
RSS_article[]
GetCountryAggregatedRSSArticlesNumber ( token,
country,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null 
)

Get the list of available articles for a country from the RSS Aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
Returns:
int
GetCountryAggregatedRSSFeeds ( token,
country 
)

Get the list of available feeds for a selected country from the RSS aggregator

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
Returns:
RSS_feed[]
GetCountryMaps ( token,
country,
day_range 
)

Get a list of maps for a given country

Parameters:
string$tokenThe session identifier
Country$countryThe country to search for
int$day_rangeThe maximum age of the maps in days [OPTIONAL]
Returns:
DMAMap[]
GetCountryQueries ( token,
country,
flavour_id = null 
)

Get the list of available queries for a defined contry

Parameters:
string$tokenThe session identifier
Country$countryThe selected country
int$flavour_idThe flavour identifier [OPTIONAL]
Returns:
Query[]
GetCountryStatisticsPerDay ( token,
countries,
startDate = null,
endDate = null 
)

Get the number of articles per day for the selected countries

Parameters:
string$tokenThe session identifier
Country[]$countries The countries for which to retrieve the statistics
int$startDateThe start date (UNIX timestamp format) - null means current day [OPTIONAL]
int$endDateThe end date (UNIX timestamp format) - null means current day. For type 1 (articles per hour) it will not be considered [OPTIONAL]
Returns:
CountryStatisticsResult[]
GetCountryStatisticsPerHour ( token,
countries,
date = null 
)

Get the number of articles per hour for the selected countries

Parameters:
string$tokenThe session identifier
Country[]$countries The countries for which to retrieve the statistics
int$dateThe date (UNIX timestamp format) - null means current day [OPTIONAL]
Returns:
CountryStatisticsResult[]
getCrisisCorrespondent ( token,
country 
)

Get the details of the Crisis Correpondent Informations of a specific Delegation

Parameters:
string$tokenSession Identifier
Country$countryIdentifier of the Country
Returns:
CrisisCorrespondent
getDelegation ( token,
delegation_id 
)

Get information about a delegation

Parameters:
string$tokenSession identifier
int$delegation_idIdentifier of the delegation
Returns:
Delegation
getDelegationPersonnel ( token,
delegation_id 
)

Get the list of personnel working in a given delegation

Parameters:
string$tokenSession identifier
int$delegation_idIdentifier of the delegation
Returns:
DelegationPersonnel[]
GetEngine ( token,
engine_id 
)

Get the content of an engine

Parameters:
string$tokenThe session identifier
string$engine_idThe engine identifier
Returns:
Engine
GetFlavour ( token,
flavour_id 
)

Get the content of flavour

Parameters:
string$tokenThe session identifier
int$flavour_idThe flavour identifier
Returns:
Flavour
getHeadsOfDelegation ( token,
delegation_id 
)

Get the list of Head of Delegation and Deputy Head of Delegation of a given Delegation

Parameters:
string$tokenSession identifier
int$delegation_idIdentifier of the delegation
Returns:
DelegationPersonnel[]
GetHomepageQueries ( token)

Get the list of available queries for the homepage

Parameters:
string$tokenThe session identifier
Returns:
Query[]
getIndarNewsletter ( token,
newsletter_id 
)

Get the content of a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier
Returns:
Newsletter
getLatestNewsArticle ( token,
id 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
string$idArticle ID
Returns:
Article
getNewsletter ( token,
newsletter_id 
)

Get the content of a newsletter

Parameters:
string$tokenThe session identifier
int$newsletter_idThe newsletter identifier
Returns:
Newsletter
getNewsletterCategory ( token,
category_id 
)

Gets a newsletter category

Parameters:
string$tokenThe session identifier
int$category_idThe category identifier public
Returns:
NewsletterCategory
GetNymexQuotations ( token)

Gets the nymex market share quotations

Parameters:
string$tokenThe session identifier
Returns:
NymexQuotation[]
GetQuery ( token,
query_id,
get_source = false,
get_engine = false 
)

Get the content of a query

Parameters:
string$tokenThe session identifier
int$query_idThe query identifier
boolean$get_sourceIf set to true, also fetch the source [OPTIONAL]
boolean$get_engineIf set to true, also fetch the engine [OPTIONAL]
Returns:
Query
getRegion ( token,
region_id 
)

Get the information about a region

Parameters:
string$tokenThe session identifier
int$region_idId of the region
Returns:
Region
getRegionList ( token,
level = null 
)

Get the master list of regions (Regions containing regions I.E: Continents)

Parameters:
string$tokenThe session identifier
int$levelWhat level of data to fetch (0 ::= Only Main Regions; 1 ::= Main Regions + Sub regions; 2 ::= Main Regions + Sub regions + Countries ) [OPTIONAL]
Returns:
MainRegion[]
GetRegionQueries ( token,
region_id,
flavour_id = null 
)

Get the list of available queries for a defined region

Parameters:
string$tokenThe session identifier
int$region_idThe selected country
int$flavour_idThe flavour identifier [OPTIONAL]
Returns:
Query[]
GetReliefWebMaps ( token,
country_id 
)

Get the reliefweb maps for a country

Parameters:
string$tokenThe session identifier
string$country_idThe country ISO2 code
Returns:
ReliefWebMap[]
GetServerVariable ( token,
key 
)

Fetch the value of a variable saved in the server's persistent storage

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable
GetServerVariables ( token)

Fetch the list of server variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetSource ( token,
source_id 
)

Get the content of a source

Parameters:
string$tokenThe session identifier
int$source_idThe source identifier
Returns:
Source
GetSystemCachedUser ( token,
user_id 
)

Get a system cached LDAP user

Parameters:
string$tokenThe session identifier
string$user_idThe user identifier
Returns:
SystemCacheUser
GetTheme ( token,
theme_id 
)

Get the content of a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
Theme
GetThemeAggregatedRSSArticles ( token,
theme_id,
time_range = null,
time_range_count = null,
record_range_from = null,
record_range_no = null 
)

Get the list of available articles for a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
Returns:
RSS_article[]
GetThemeAggregatedRSSFeeds ( token,
theme_id 
)

Get the list of available feeds for a selected theme from the RSS Aggregator

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme
Returns:
RSS_feed[]
GetThemeQueries ( token,
theme_id 
)

Get the list of available queries for a defined contry

Parameters:
string$tokenThe session identifier
int$theme_idThe selected theme identifier
Returns:
Query[]
GetThemeTopic ( token,
topic_id 
)

Get a topic theme

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
Returns:
ThemeTopic
GetTopicQuery ( token,
topic_id,
query_id 
)

Get a topic query

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
int$query_idThe query identifier
Returns:
TopicQuery
GetUserPersistentVariable ( token,
key 
)

Fetch the value of a variable saved in the user's session

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable

Fetch the list of user's persistent variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetUserSessionVariable ( token,
key 
)

Fetch the value of a variable saved in the user's session

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable

Fetch the list of user's session variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetVideoQueries ( token)

Get the list of available queries for the homepage

Parameters:
string$tokenThe session identifier
Returns:
Query[]
GetWikipediaCountryProfile ( token,
country 
)

Return a country profile from Wikipedia

Parameters:
string$tokenSecurity Token
Country$countryCountry object
Returns:
WikipediaCountryProfile
googleFetch ( token,
resultset,
first = null,
count = null 
)

Fetch the next articles from a Google Search (returns NULL when no more articles are available)

Parameters:
string$tokenSession Identifier
GoogleResultset$resultsetResultset
int$firstThe first article [OPTIONAL]
int$countCount of articles [OPTIONAL]
Returns:
GoogleResultset
googleGetDocument ( token,
url 
) [protected]

Parses a google document

Parameters:
string$tokenThe session identifier
string$urlThe document url protected
Returns:
string
googleSearch ( token,
query 
)

Search for articles using Google News

Parameters:
string$tokenSession Identifier
GoogleQuery$queryQuery
Returns:
GoogleResultset
latestNewsFetch ( token,
resultset,
first = null,
count = null 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
LatestNewsResultset$resultsetThe resultset returned by a latestNewsSearch() operation
int$first[OPTIONAL]
int$count[OPTIONAL]
Returns:
LatestNewsDocument[]
latestNewsGetDocument ( token,
id 
)

Get a LatestNews Document

Parameters:
string$tokenSession Identifier
int$idArticle ID
Returns:
LatestNewsDocument
latestNewsSearch ( token,
query,
range = null 
)

Search for articles in the LatestNews database

Parameters:
string$tokenSession Identifier
string$querySQL query
float$rangeTime range in days (you may use fractions!) [OPTIONAL]
Returns:
LatestNewsResultset
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
LexisNexisBrowseSources ( token,
folderId = null 
)

Browse LexisNexis Source Folders

Parameters:
string$tokenSession Identifier
int$folderIdID of the folder to browse (if null, the root folder will be browsed) [OPTIONA]
Returns:
LexisNexisBrowseSourcesResponse
LexisNexisGetAttachments ( token,
attachmentId 
)

Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]

Parameters:
string$tokenSession Identifier
string$attachmentIdAttachment ID
Returns:
LexisNexisAttachment[]
LexisNexisGetDocuments ( token,
searchId,
begin = 1,
end = 20 
)

Retrieve specific documents in SITE (preview) format

Parameters:
string$tokenSession Identifier
string$searchIdContains a unique identifier that identifies the original search.
int$beginIdentifies the first document to be returned in the response. It must be used in conjunction with end.
int$endIdentifies the last document to be returned in the response. It must be used in conjunction with begin.
Returns:
LexisNexisDocument[]
LexisNexisGetFullDocument ( token,
documentId 
)

Retrieve specific document in full text

Parameters:
string$tokenSession Identifier
string$documentIdDocument ID
Returns:
LexisNexisDocument
LexisNexisGetSortKeys ( token,
searchId 
)

Get the Sort Keys available for each row of a LexisNexis SearchResult

Parameters:
string$tokenSession Identifier
string$searchIdLexisNexis Search ID
Returns:
Pair[]
LexisNexisSearch ( token,
query 
)

Search LexisNexis datawarehouse, and return a SearchID

Parameters:
string$tokenSession Identifier
LexisNexisQuery$queryThe search query
Returns:
LexisNexisSearchResult
LexisNexisSourceSearch ( token,
query 
)

Searches LexisNexis sources

Parameters:
string$tokenThe session identifier
LexisNexisSourceSearchRequest$queryThe query for searching the sources
Returns:
LexisNexisSourceSearchResponse

Lists the sources for the advanced search

Parameters:
string$tokenThe token identifier public
Returns:
AdvancedSearch[]
ListAggregatedLatestnewsArticles ( token,
feed_id = null,
time_range = null,
record_range_from = null,
record_range_no = null,
time_range_count = null 
)

Get the list of available articles from Latestnews aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of articles to be retrieved from the first article(null means all articles) [OPTIONAL]
int$time_range_countThe number of days starting from time range (null means all articles) [OPTIONAL]
Returns:
Latestnews_article[]

Get the list of available feeds from latestnews aggregator

Parameters:
string$tokenThe session identifier
Returns:
Latestnews_feed[]
ListAggregatedRSSArticles ( token,
feed_id = null,
time_range = null,
record_range_from = null,
record_range_no = null,
time_range_count = null 
)

Get the list of available articles from the Aggregator

Parameters:
string$tokenThe session identifier
int$feed_idThe feed identifier (null means all articles) [OPTIONAL]
int$time_rangeThe time range for articles in days (null means all articles) [OPTIONAL]
int$record_range_fromThe number of the first article to be retrieved (null means all articles) [OPTIONAL]
int$record_range_noThe number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL]
int$time_range_countThe time range count for articles in days (null means all articles) [OPTIONAL]
Returns:
RSS_article[]
ListAggregatedRSSFeeds ( token)

Get the list of available feeds from RSS Aggregator

Parameters:
string$tokenThe session identifier
Returns:
RSS_feed[]
ListClusters ( token,
fetch_countries = null 
)

Get the list of available clusters

Parameters:
string$tokenThe session identifier
boolean$fetch_countriesIf set to true, the method will also return the list of countries belonging to the region (default: false) [OPTIONAL]
Returns:
Cluster[]
listContinents ( token)

Get the master list of continents

Parameters:
string$tokenThe session identifier
Returns:
Continent[]
listCountries ( token,
continent_id = null,
eu_members_only = null,
official_only = null,
region_id = null 
)

Get the master list of countries

Parameters:
string$tokenThe session identifier
int$continent_idRestricts the list to a given Continent [OPTIONAL]
boolean$eu_members_onlyIf true, restricts the list to EU countries, if False, restricts it to NON-EU members [OPTIONAL]
boolean$official_onlyIt true, restricts the list to official countries, if False, restricts it to non official countries [OPTIONAL]
int$region_idThe official region identifier [OPTIONAL]
Returns:
Country[]
listCountries2 ( token,
continent_id = null,
eu_members_only = null,
official_only = null 
)

Get the master list of countries

Parameters:
string$tokenThe session identifier
int$continent_idRestricts the list to a given Continent [OPTIONAL]
boolean$eu_members_onlyIf true, restricts the list to EU countries, if False, restricts it to NON-EU members [OPTIONAL]
boolean$official_onlyIt true, restricts the list to official countries, if False, restricts it to non official countries [OPTIONAL]
Returns:
Country2[]
listCrisisCorrespondents ( token,
countries 
)

Get the list of CrisisCorrepondents (eventually filtered on a list of countries)

Parameters:
string$tokenSession Identifier
Country[]$countries Country list filter [OPTIONAL]
Returns:
CrisisCorrespondent[]
ListCrisisRoomUsers ( token)

List the crisis room users

Parameters:
string$tokenThe session identifier
Returns:
string[]
listDelegations ( token,
country 
)

Get a list of all available delegations (eventually filtered by country)

Parameters:
string$tokenSession identifier
Country$countryCountry filter [OPTIONAL]
Returns:
Delegation[]
listDelegations2 ( token,
countries 
)

Get a list of all available delegations (eventually filtered on a list of countries)

Parameters:
string$tokenSession identifier
Country[]$countries Country list filter
Returns:
Delegation[]
ListEngines ( token)

Get the list of available engines

Parameters:
string$tokenThe session identifier
Returns:
Engine[]
ListFlavours ( token)

Get the list of available flavours

Parameters:
string$tokenThe session identifier
Returns:
Flavour[]
ListGlobalAtlasMaps ( token,
country,
dayRange = null 
)

Returns the list of maps for a country

Parameters:
string$tokenThe session identifier
Country$countryThe country for which to retrieve the map
int$dayRangeThe days for which to retrieve the maps [OPTIONAL]
Returns:
GlobalAtlas[]
ListHotSpots ( token,
day = null 
)

Get the list of hotspots for a day

Parameters:
string$tokenThe session identifier
int$dayThe day for which to retrieve the hotspots (null means the current date) [OPTIONAL]
Returns:
string[] A list of countries iso codes.
listIndarNewsletters ( token)

Get the list of available newsletters

Parameters:
string$tokenThe session identifier
Returns:
Newsletter[]

List the LDAP departments from system cache

Parameters:
string$tokenThe session identifier
Returns:
string[]
ListNewsletters ( token,
category_id = null 
)

Get the list of available newsletters

Parameters:
string$tokenThe session identifier
int$category_idThe category identifier [OPTIONAL]
Returns:
Newsletter[]

Lists the newsletters categories

Parameters:
string$tokenThe session identifier public
Returns:
NewsletterCategory[]
ListNewStickerGroups ( token)

Lists the news stickers groups

Parameters:
string$tokenThe session identifier
Returns:
NewStickerGroup[]
listOfficialRegions ( token,
continent_id 
)

Gets a list of the official regions

Parameters:
string$tokenThe session identifier
int$continent_idThe continent identifier [OPTIONAL] public
Returns:
OfficialRegion[]
ListQueries ( token)

Get the list of available queries

Parameters:
string$tokenThe session identifier
Returns:
Query[]
ListQuickSearchSources ( token)

Get the list of quicksearch sources

Parameters:
string$tokenThe session identifier
Returns:
QuickSearchSource[]
ListRadioChannels ( token,
category_id = null 
)

List the Radio channels

Parameters:
string$tokenThe session identifier
integer$category_idThe channel category [OPTIONAL]
Returns:
TariqaRadioChannel[]

List the Radio channels category

Parameters:
string$tokenThe session identifier
Returns:
TariqaRadioChannelCategory[]
listRegions ( token,
fetch_countries = null 
)

Get the list of all regions

Parameters:
string$tokenThe session identifier
boolean$fetch_countriesIf set to true, the method will also return the list of countries belonging to the region (default: false) [OPTIONAL]
Returns:
Region[]
ListSources ( token)

Get the list of available sources

Parameters:
string$tokenThe session identifier
Returns:
Source[]
ListSystemCachedUsers ( token,
department = null 
)

Gets a list of users from the system cache

Parameters:
string$tokenThe session identifier
string$departmentThe LDAP departments from which to list the users [OPTIONAL]
Returns:
SystemCacheUser[]
ListThemes ( token,
no_texts = false 
)

Get the list of available themes

Parameters:
string$tokenThe session identifier
boolean$no_textsIf true, do not fetch the texts [OPTIONAL]
Returns:
Theme[]
ListThemeTopics ( token,
theme_id 
)

Lists the topics for a given theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeTopic[]
ListThemeTopicsWithQueries ( token,
theme_id 
)

List the topics themes with queries

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeTopicCollection[]
ListThemeUsers ( token,
theme_id 
)

Lists the theme users

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Returns:
ThemeUsers
ListTopicQueries ( token,
topic_id 
)

Lists the queries for a theme topic

Parameters:
string$tokenThe session identifier
int$topic_idThe topic identifier
Returns:
TopicQuery[]
ListTVChannels ( token,
category_id = null 
)

List the TV channels

Parameters:
string$tokenThe session identifier
integer$category_idThe channel category [OPTIONAL]
Returns:
TariqaTVChannel[]

List the TV channels category

Parameters:
string$tokenThe session identifier
Returns:
TariqaTVChannelCategory[]
listVideoArchiveChannels ( token,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Get the list of available Channels from the video archive (channels that have records)

Parameters:
string$tokenThe session identifier
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
string[]
listVideoArchiveRecords ( token,
first_record = null,
record_count = null,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Get the list of available Records from the video archive

Parameters:
string$tokenThe session identifier
int$first_recordNumber of the first record to return (default 0) [OPTIONAL]
int$record_countNumber of records to return (default all) [OPTIONAL]
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
VideoArchiveRecord[]
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 
) [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
Returns:
OxfordAnalyticaSearchResult
oxanSimpleSearch ( token,
query 
)

Search Oxford Analytica

Parameters:
string$tokenSession Identifier
OxfordAnalyticaSimpleQuery$query
Returns:
OxfordAnalyticaSearchResult
saveNewsletter ( token,
newsletter 
)

Saves or updates a newsletter into the database database (for insert, just set the newsletter_id to null)

Parameters:
string$tokenThe session identifier
Newsletter$newsletterThe newsletter public
Returns:
int
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
SetServerVariable ( token,
key,
value 
)

Save a variable in the server's persistent storage

Parameters:
string$tokenSession identifier
string$keyVariable name (255 characters max)
string$valueValue
Returns:
boolean
SetServerVariables ( token,
variables 
)

Set all server variables at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean
SetThemeText ( token,
theme_id,
short_text,
long_text 
)

Sets the short text and long text of a theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
string$short_textThe short text
string$long_textThe long text
Returns:
boolean
SetThemeUserDefinedQuery ( token,
theme_id,
query 
)

Sets the user defined query for the theme

Parameters:
string$tokenThe session identifier
int$theme_idThe theme identifier
Query$queryThe query
Returns:
int
SetUserPersistentVariable ( token,
key,
value 
)

Save a variable in the user's persistent storage

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
Returns:
boolean
SetUserPersistentVariables ( token,
variables 
)

Set all user's persistent variables at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean
SetUserSessionVariable ( token,
key,
value 
)

Save a variable in the user's session

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
Returns:
boolean
SetUserSessionVariables ( token,
variables 
)

Set all user's session variables at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean
SetUserVariable ( token,
key,
value,
persistent = false 
) [protected]

Save a variable in the user's session

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
boolean$persistentIf false (default) look for the value in the session, otherwise look in the persistent data of the user
Returns:
boolean
SetUserVariables ( token,
variables,
persistent = false 
) [protected]

Save all variables in the user's session or persistent storage at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
boolean$persistentIf false (default) look for the value in the session, otherwise look in the persistent data of the user
Returns:
boolean
UpdateAggregatedLatestnewsFeed ( token,
feed 
)

Updates an existing Latestnews Feed

Parameters:
string$tokenThe session identifier
Latestnews_feed$feedThe new feed to be inserted in the database
Returns:
int (The number of records affected)
UpdateAggregatedRSSFeed ( token,
feed 
)

Updates an existing RSS Feed

Parameters:
string$tokenThe session identifier
RSS_feed$feedThe new feed to be inserted in the database
Returns:
int (The number of records affected)
videoArchiveBuildSQLQuery ( first_record = null,
record_count = null,
channel = null,
start_date = null,
end_date = null,
title = null 
) [protected]

Build the SQL query for Vide Archive Access

Parameters:
int$first_recordNumber of the first record to return (default 0) [OPTIONAL]
int$record_countNumber of records to return (default all) [OPTIONAL]
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
string
VirageGetDocument ( token,
document_id,
getImages 
)

Get a Virage document

Parameters:
string$tokenThe session identifier
int$document_idThe document identifier
boolean$getImagesIf true, then it also returns the document images
Returns:
VirageDocument
VirageGetDocumentAllImages ( token,
document_id,
type,
getContent,
cache,
document = null 
)

Gets all the images from a document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
string$typeThe type of image to retrieve (small or big)
boolean$getContentIf set to false, do not retrieve the image content [OPTIONAL]
boolean$cacheIf set to true, also cache the image [OPTIONAL]
VirageDocument$documentThe document [OPTIONAL] public
Returns:
VirageDocumentImage[]

Gets all the headlines of a video document

Parameters:
string$tokenThe session identifier public
Returns:
VirageHeadline[]
VirageGetDocumentImages ( token,
document_id 
)

Get a Virage document images

Parameters:
string$tokenThe session identifier
int$document_idThe document identifier
Returns:
VirageDocumentImages
VirageGetFullText ( token,
document_id,
document = null 
)

Get the full text of a video document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
VirageDocument$documentThe document [OPTIONAL] public
Returns:
string
VirageGetWords ( token,
document_id,
complete = true,
document = null 
)

Gets the list of words

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
boolean$completeIf set to true, get the words for the entire movie [OPTIONAL]
VirageDocument$documentThe document [OPTIONAL] public
Returns:
VirageWord[]
VirageSearch ( token,
query 
)

Search for a video in the database using Virage

Parameters:
string$tokenThe session identifier
VirageSearchQuery$queryThe query to be executed
Returns:
VirageSearchResult
VirageSearch2 ( token,
query 
)

Search for a video in the database using Virage and returns the complete document without the images

Parameters:
string$tokenThe session identifier
VirageSearchQuery$queryThe query to be executed
Returns:
VirageSearchResult
WSK2LN_BrowseSourcesResponse ( object,
folderId = null 
) [protected]

Converts a WSKBrowseSourcesResponse into a LexisNexisBrowseSourcesResponse

Parameters:
WSKBrowseSourcesResponse$objectResponse object
int$folderIdID of the folder currently browsed
Returns:
LexisNexisBrowseSourcesResponse
WSKAuthenticate ( ) [protected]

Establish a connection with the LexisNexis WSK and return the security token (might be cached for performance reasons)

Returns:
string WSK BinarySecurityToken
WSKBrowseSources ( folderId = null) [protected]

Get a list of available Sources

Parameters:
int$folderId[OPTIONAL]
Returns:
WSKBrowseSourcesResponse

Field Documentation

$retry = 0 [protected]
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_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"

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