Tariqa
3.0
|
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 |
Class for using the SOAP service
__construct | ( | $ | options = null , |
$ | config, | ||
$ | user | ||
) |
array | $options | An array of options to pass to the SoapClient constructor |
array | $config | The configuration array |
tariqaUser | $user | The ECAS user |
__call | ( | $ | name, |
$ | arguments | ||
) |
Calls a SOAP method
string | $name | The name of the method |
array | $arguments | The arguments of the method public |
_fetchUrl | ( | $ | request | ) | [protected] |
Fetch a document from the internet
WebRequest | $request | HTTP query |
_fetchUrlNoProxy | ( | $ | request | ) | [protected] |
Fetch a document from the intranet
WebRequest | $request | HTTP query |
_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
string | $iso2 | ISO 3166(2 alpha) [OPTIONAL] |
string | $iso3 | ISO 3166(3 alpha) [OPTIONAL] |
int | $isonum | ISO 3166(numeric) [OPTIONAL] |
string | $comref | E.C. COMREF PriKey [OPTIONAL] |
string | $sysper | E.C. SYSPER2 [OPTIONAL] |
string | $iana | Internet Assigned Numbers Authority [OPTIONAL] |
string | $ioc | International Olympic Committee [OPTIONAL] |
string | $un | U.N. International Traffic Distinguished Signs [OPTIONAL] |
string | $itu | I.T.U Codes for International Telephone calls [OPTIONAL] |
string | $oxan_id | Oxford Analytica's Country Name [OPTIONAL] |
string | $comref_del | E.C. COMREF - Delegation Country ID (if it differs from $comref) [OPTIONAL] |
_getEngine | ( | $ | token, |
$ | engine_id | ||
) |
Get the content of an engine without authentication
string | $token | The session identifier |
string | $engine_id | The engine identifier |
_GetServerVariable | ( | $ | key | ) | [protected] |
Fetch the value of a variable saved in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
string | $key | The variable name (255 characters max) |
_GetServerVariables | ( | ) | [protected] |
Fetch the list of server variables (WITHOUT CHECKING THE SESSION TOKEN)
string | $token | The session identifier |
_googleSearch | ( | $ | query | ) | [protected] |
Search for articles using Google News
string | $token | Session Identifier |
GoogleQuery | $query | Query |
_LexisNexisGetAttachments | ( | $ | attachmentId | ) | [protected] |
Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]
string | $attachmentId | Attachment ID |
_LexisNexisGetFullDocument | ( | $ | documentId | ) | [protected] |
Retrieve specific document in full text [WITHOUT CHECKING USER's TOKEN]
string | $documentId | Document ID |
_listHotSpots | ( | $ | day = null | ) | [protected] |
Get the list of hotspots for a day without authentification
int | $day | The day for which to retrieve the hotspots (null means the current date) [OPTIONAL] |
_SetServerVariable | ( | $ | key, |
$ | value | ||
) | [protected] |
Save a variable in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
string | $token | Session identifier |
string | $key | Variable name (255 characters max) |
string | $value | Value |
_SetServerVariables | ( | $ | variables | ) | [protected] |
Set all server variables at once (WITHOUT CHECKING THE SESSION TOKEN)
string | $token | The session identifier |
Pair[] | $variables The list of variables |
canEditNewsletter | ( | $ | token, |
$ | user_id, | ||
$ | newsletter_ids | ||
) |
Tells if an user can edit a newsletter
string | $token | The session identifier |
string | $user_id | The user identifier |
int[] | $newsletter_ids An array of newsletter identifiers public |
canEditNewsletterCategory | ( | $ | token, |
$ | user_id, | ||
$ | category_ids | ||
) |
Tells if an user can edit a newsletter category
string | $token | The session identifier |
string | $user_id | The user identifier |
int[] | $category_ids An array of newsletter categories identifiers public |
CheckToken | ( | $ | token | ) | [protected] |
Checks the validity of a token
string | $token | The session identifier |
countVideoArchiveRecords | ( | $ | token, |
$ | channel = null , |
||
$ | start_date = null , |
||
$ | end_date = null , |
||
$ | title = null |
||
) |
Count the number of available Records from the video archive
string | $token | The session identifier |
string | $channel | Channel name (* wildcard supported) [OPTIONAL] |
int | $start_date | Start date (unix timestamp) [OPTIONAL] |
int | $end_date | End date (unix timestamp) [OPTIONAL] |
string | $title | Program title (* wildcard supported) [OPTIONAL] |
CreateAggregatedLatestnewsFeed | ( | $ | token, |
$ | feed, | ||
$ | country, | ||
$ | theme | ||
) |
Creates a new Latestnews Feed
string | $token | The session identifier |
Latestnews_feed | $feed | The new feed to be inserted in the database |
Country | $country | The feed country (null if there is not a country for this feed) |
Theme | $theme | The feed theme (null if there is not a theme for this feed) |
CreateAggregatedRSSFeed | ( | $ | token, |
$ | feed, | ||
$ | country, | ||
$ | theme | ||
) |
DeleteAggregatedLatestnewsFeed | ( | $ | token, |
$ | feed_id | ||
) |
Deletes a Latestnews Feed
string | $token | The session identifier |
int | $feed_id | The feed identificator |
DeleteAggregatedRSSFeed | ( | $ | token, |
$ | feed_id | ||
) |
Deletes a RSS Feed
string | $token | The session identifier |
int | $feed_id | The feed identificator |
deleteNewsletter | ( | $ | token, |
$ | newsletter_id | ||
) |
Deletes a newsletter
string | $token | The session identifier |
int | $newsletter_id | The newsletter identifier public |
DeleteThemeUserDefinedQuery | ( | $ | token, |
$ | theme_id | ||
) |
Deletes a theme user defined query
string | $token | The session identifier |
int | $theme_id | The theme identifier |
FactivaContentSearch | ( | $ | token, |
$ | query | ||
) |
Search for articles using Factiva
string | $token | Session Identifier |
FactivaContentQuery | $query | The factiva query |
FactivaGetDocument | ( | $ | token, |
$ | accessionNo | ||
) |
Retrieve a factiva document
string | $token | Session Identifier |
string | $accessionNo | The document identifier |
Retrieve the control data from the session files
FactivaSourceGroupSearch | ( | $ | token, |
$ | query | ||
) |
Search for articles using Google News
string | $token | Session Identifier |
FactivaSourceGroupQuery | $query | The factiva query |
FactivaSourceSearch | ( | $ | token, |
$ | query | ||
) |
Search for sources using Factiva
string | $token | Session Identifier |
FactivaSourceQuery | $query | The factiva query |
fetchBuzztracker | ( | $ | token, |
$ | date | ||
) |
Get the Buzztracker map of a given date
string | $token | Session identifier |
int | $date | The date to fetch (unix format timestamp) |
fetchLatestNews | ( | $ | token, |
$ | query, | ||
$ | range = null , |
||
$ | page_number = null , |
||
$ | page_size = null , |
||
$ | paginal = true |
||
) |
Fetch the articles from the LatestNews database
string | $token | Session Identifier |
string | $query | SQL query |
float | $range | Time range in days (you may use fractions!) [OPTIONAL] |
int | $page_number | Which page of articles to fetch [OPTIONAL] |
int | $page_size | How many articles should be displayed on each page [OPTIONAL] |
boolean | $paginal | If set to true, the results are paginated, else page_number represents the first result, and page_size the number of results [OPTIONAL] |
fetchRSS | ( | $ | token, |
$ | url, | ||
$ | first = null , |
||
$ | count = null |
||
) |
fetchUrl | ( | $ | token, |
$ | request | ||
) |
Fetch a document from the internet
string | $token | Session identifier |
WebRequest | $request | HTTP query |
GetAggregatedLatestnewsArticle | ( | $ | token, |
$ | article_id | ||
) |
Get an article from Latestnews Aggregator
string | $token | The session identifier |
int | $article_id | The article identifier |
GetAggregatedLatestnewsArticlesNumber | ( | $ | token, |
$ | feed_id = null , |
||
$ | time_range = null , |
||
$ | time_range_count = null |
||
) |
Get the number of available articles from Latestnews aggregator
string | $token | The session identifier |
int | $feed_id | The feed identifier (null means all articles) [OPTIONAL] |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The number of days starting from time range (null means all articles) [OPTIONAL] |
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
string | $token | The session identifier |
Country | $country | The selected country |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
GetAggregatedLatestnewsCountryArticlesNumber | ( | $ | token, |
$ | country, | ||
$ | time_range = null , |
||
$ | time_range_count = null |
||
) |
Get the number of available latestnews articles for a country
string | $token | The session identifier |
Country | $country | The selected country |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
GetAggregatedLatestnewsCountryFeeds | ( | $ | token, |
$ | country | ||
) |
Get the list of available latestnews feeds for a selected country
string | $token | The session identifier |
Country | $country | The selected country |
GetAggregatedLatestnewsFeed | ( | $ | token, |
$ | feed_id | ||
) |
Get a feed from Latestnews Aggregator
string | $token | The session identifier |
int | $feed_id | The feed identifier |
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
string | $token | The session identifier |
int | $theme_id | The selected theme |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
GetAggregatedLatestnewsThemeFeeds | ( | $ | token, |
$ | theme_id | ||
) |
Get the list of available latestnews feeds for a selected theme
string | $token | The session identifier |
int | $theme_id | The selected theme |
GetAggregatedRSSArticle | ( | $ | token, |
$ | article_id | ||
) |
Get an article from the RSS Aggregator
string | $token | The session identifier |
int | $article_id | The article identifier |
GetAggregatedRSSArticlesNumber | ( | $ | token, |
$ | feed_id = null , |
||
$ | time_range = null , |
||
$ | time_range_count = null |
||
) |
Get the number of available articles from the Aggregator
string | $token | The session identifier |
int | $feed_id | The feed identifier (null means all articles) [OPTIONAL] |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
GetAggregatedRSSFeed | ( | $ | token, |
$ | feed_id | ||
) |
GetCluster | ( | $ | token, |
$ | cluster_id | ||
) |
Get the content of a cluster
string | $token | The session identifier |
int | $cluster_id | The cluster identifier |
getContinent | ( | $ | token, |
$ | continent_id | ||
) |
Get the information about a continent
string | $token | The session identifier |
int | $continent_id | Id of the 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
string | $token | The session identifier |
string | $iso2 | ISO 3166(2 alpha) [OPTIONAL] |
string | $iso3 | ISO 3166(3 alpha) [OPTIONAL] |
int | $isonum | ISO 3166(numeric) [OPTIONAL] |
string | $comref | E.C. COMREF PriKey [OPTIONAL] |
string | $sysper | E.C. SYSPER2 [OPTIONAL] |
string | $iana | Internet Assigned Numbers Authority [OPTIONAL] |
string | $ioc | International Olympic Committee [OPTIONAL] |
string | $un | U.N. International Traffic Distinguished Signs [OPTIONAL] |
string | $itu | I.T.U Codes for International Telephone calls [OPTIONAL] |
string | $oxan_id | Oxford Analytica's Country Name [OPTIONAL] |
string | $comref_del | E.C. COMREF - Delegation Country ID (if it differs from $comref) [OPTIONAL] |
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
string | $token | The session identifier |
Country | $country | The selected country |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
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
string | $token | The session identifier |
Country | $country | The selected country |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
GetCountryAggregatedRSSFeeds | ( | $ | token, |
$ | country | ||
) |
GetCountryMaps | ( | $ | token, |
$ | country, | ||
$ | day_range | ||
) |
GetCountryQueries | ( | $ | token, |
$ | country, | ||
$ | flavour_id = null |
||
) |
GetCountryStatisticsPerDay | ( | $ | token, |
$ | countries, | ||
$ | startDate = null , |
||
$ | endDate = null |
||
) |
Get the number of articles per day for the selected countries
string | $token | The session identifier |
Country[] | $countries The countries for which to retrieve the statistics | |
int | $startDate | The start date (UNIX timestamp format) - null means current day [OPTIONAL] |
int | $endDate | The end date (UNIX timestamp format) - null means current day. For type 1 (articles per hour) it will not be considered [OPTIONAL] |
GetCountryStatisticsPerHour | ( | $ | token, |
$ | countries, | ||
$ | date = null |
||
) |
Get the number of articles per hour for the selected countries
string | $token | The session identifier |
Country[] | $countries The countries for which to retrieve the statistics | |
int | $date | The date (UNIX timestamp format) - null means current day [OPTIONAL] |
getCrisisCorrespondent | ( | $ | token, |
$ | country | ||
) |
Get the details of the Crisis Correpondent Informations of a specific Delegation
getDelegation | ( | $ | token, |
$ | delegation_id | ||
) |
Get information about a delegation
string | $token | Session identifier |
int | $delegation_id | Identifier of the delegation |
getDelegationPersonnel | ( | $ | token, |
$ | delegation_id | ||
) |
Get the list of personnel working in a given delegation
string | $token | Session identifier |
int | $delegation_id | Identifier of the delegation |
GetEngine | ( | $ | token, |
$ | engine_id | ||
) |
Get the content of an engine
string | $token | The session identifier |
string | $engine_id | The engine identifier |
GetFlavour | ( | $ | token, |
$ | flavour_id | ||
) |
Get the content of flavour
string | $token | The session identifier |
int | $flavour_id | The flavour identifier |
getHeadsOfDelegation | ( | $ | token, |
$ | delegation_id | ||
) |
Get the list of Head of Delegation and Deputy Head of Delegation of a given Delegation
string | $token | Session identifier |
int | $delegation_id | Identifier of the delegation |
GetHomepageQueries | ( | $ | token | ) |
Get the list of available queries for the homepage
string | $token | The session identifier |
getIndarNewsletter | ( | $ | token, |
$ | newsletter_id | ||
) |
Get the content of a newsletter
string | $token | The session identifier |
int | $newsletter_id | The newsletter identifier |
getLatestNewsArticle | ( | $ | token, |
$ | id | ||
) |
getNewsletter | ( | $ | token, |
$ | newsletter_id | ||
) |
Get the content of a newsletter
string | $token | The session identifier |
int | $newsletter_id | The newsletter identifier |
getNewsletterCategory | ( | $ | token, |
$ | category_id | ||
) |
Gets a newsletter category
string | $token | The session identifier |
int | $category_id | The category identifier public |
GetNymexQuotations | ( | $ | token | ) |
Gets the nymex market share quotations
string | $token | The session identifier |
GetQuery | ( | $ | token, |
$ | query_id, | ||
$ | get_source = false , |
||
$ | get_engine = false |
||
) |
Get the content of a query
string | $token | The session identifier |
int | $query_id | The query identifier |
boolean | $get_source | If set to true, also fetch the source [OPTIONAL] |
boolean | $get_engine | If set to true, also fetch the engine [OPTIONAL] |
getRegion | ( | $ | token, |
$ | region_id | ||
) |
Get the information about a region
string | $token | The session identifier |
int | $region_id | Id of the region |
getRegionList | ( | $ | token, |
$ | level = null |
||
) |
Get the master list of regions (Regions containing regions I.E: Continents)
string | $token | The session identifier |
int | $level | What level of data to fetch (0 ::= Only Main Regions; 1 ::= Main Regions + Sub regions; 2 ::= Main Regions + Sub regions + Countries ) [OPTIONAL] |
GetRegionQueries | ( | $ | token, |
$ | region_id, | ||
$ | flavour_id = null |
||
) |
Get the list of available queries for a defined region
string | $token | The session identifier |
int | $region_id | The selected country |
int | $flavour_id | The flavour identifier [OPTIONAL] |
GetReliefWebMaps | ( | $ | token, |
$ | country_id | ||
) |
Get the reliefweb maps for a country
string | $token | The session identifier |
string | $country_id | The country ISO2 code |
GetServerVariable | ( | $ | token, |
$ | key | ||
) |
Fetch the value of a variable saved in the server's persistent storage
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
GetServerVariables | ( | $ | token | ) |
Fetch the list of server variables
string | $token | The session identifier |
GetSource | ( | $ | token, |
$ | source_id | ||
) |
Get the content of a source
string | $token | The session identifier |
int | $source_id | The source identifier |
GetSystemCachedUser | ( | $ | token, |
$ | user_id | ||
) |
Get a system cached LDAP user
string | $token | The session identifier |
string | $user_id | The user identifier |
GetTheme | ( | $ | token, |
$ | theme_id | ||
) |
Get the content of a theme
string | $token | The session identifier |
int | $theme_id | The theme identifier |
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
string | $token | The session identifier |
int | $theme_id | The selected theme |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
GetThemeAggregatedRSSFeeds | ( | $ | token, |
$ | theme_id | ||
) |
GetThemeQueries | ( | $ | token, |
$ | theme_id | ||
) |
Get the list of available queries for a defined contry
string | $token | The session identifier |
int | $theme_id | The selected theme identifier |
GetThemeTopic | ( | $ | token, |
$ | topic_id | ||
) |
Get a topic theme
string | $token | The session identifier |
int | $topic_id | The topic identifier |
GetTopicQuery | ( | $ | token, |
$ | topic_id, | ||
$ | query_id | ||
) |
Get a topic query
string | $token | The session identifier |
int | $topic_id | The topic identifier |
int | $query_id | The query identifier |
GetUserPersistentVariable | ( | $ | token, |
$ | key | ||
) |
Fetch the value of a variable saved in the user's session
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
GetUserPersistentVariables | ( | $ | token | ) |
Fetch the list of user's persistent variables
string | $token | The session identifier |
GetUserSessionVariable | ( | $ | token, |
$ | key | ||
) |
Fetch the value of a variable saved in the user's session
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
GetUserSessionVariables | ( | $ | token | ) |
Fetch the list of user's session variables
string | $token | The session identifier |
GetVideoQueries | ( | $ | token | ) |
Get the list of available queries for the homepage
string | $token | The session identifier |
GetWikipediaCountryProfile | ( | $ | token, |
$ | country | ||
) |
Return a country profile from Wikipedia
googleFetch | ( | $ | token, |
$ | resultset, | ||
$ | first = null , |
||
$ | count = null |
||
) |
Fetch the next articles from a Google Search (returns NULL when no more articles are available)
string | $token | Session Identifier |
GoogleResultset | $resultset | Resultset |
int | $first | The first article [OPTIONAL] |
int | $count | Count of articles [OPTIONAL] |
googleGetDocument | ( | $ | token, |
$ | url | ||
) | [protected] |
Parses a google document
string | $token | The session identifier |
string | $url | The document url protected |
googleSearch | ( | $ | token, |
$ | query | ||
) |
Search for articles using Google News
string | $token | Session Identifier |
GoogleQuery | $query | Query |
latestNewsFetch | ( | $ | token, |
$ | resultset, | ||
$ | first = null , |
||
$ | count = null |
||
) |
Fetch the articles from the LatestNews database
string | $token | Session Identifier |
LatestNewsResultset | $resultset | The resultset returned by a latestNewsSearch() operation |
int | $first | [OPTIONAL] |
int | $count | [OPTIONAL] |
latestNewsGetDocument | ( | $ | token, |
$ | id | ||
) |
Get a LatestNews Document
string | $token | Session Identifier |
int | $id | Article ID |
latestNewsSearch | ( | $ | token, |
$ | query, | ||
$ | range = null |
||
) |
Search for articles in the LatestNews database
string | $token | Session Identifier |
string | $query | SQL query |
float | $range | Time range in days (you may use fractions!) [OPTIONAL] |
ldapFullSearch | ( | $ | token, |
$ | filter, | ||
$ | max_time, | ||
$ | max_results | ||
) |
Search the Commission's LDAP database
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 | ( | $ | token, |
$ | name, | ||
$ | max_time, | ||
$ | max_results | ||
) |
Search the Commission's LDAP database by name or user id
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] |
LexisNexisBrowseSources | ( | $ | token, |
$ | folderId = null |
||
) |
Browse LexisNexis Source Folders
string | $token | Session Identifier |
int | $folderId | ID of the folder to browse (if null, the root folder will be browsed) [OPTIONA] |
LexisNexisGetAttachments | ( | $ | token, |
$ | attachmentId | ||
) |
Retrieve a specific attachment [WITHOUT CHECKING USER's TOKEN]
string | $token | Session Identifier |
string | $attachmentId | Attachment ID |
LexisNexisGetDocuments | ( | $ | token, |
$ | searchId, | ||
$ | begin = 1 , |
||
$ | end = 20 |
||
) |
Retrieve specific documents in SITE (preview) format
string | $token | Session Identifier |
string | $searchId | Contains a unique identifier that identifies the original search. |
int | $begin | Identifies the first document to be returned in the response. It must be used in conjunction with end. |
int | $end | Identifies the last document to be returned in the response. It must be used in conjunction with begin. |
LexisNexisGetFullDocument | ( | $ | token, |
$ | documentId | ||
) |
Retrieve specific document in full text
string | $token | Session Identifier |
string | $documentId | Document ID |
LexisNexisGetSortKeys | ( | $ | token, |
$ | searchId | ||
) |
LexisNexisSearch | ( | $ | token, |
$ | query | ||
) |
Search LexisNexis datawarehouse, and return a SearchID
string | $token | Session Identifier |
LexisNexisQuery | $query | The search query |
LexisNexisSourceSearch | ( | $ | token, |
$ | query | ||
) |
Searches LexisNexis sources
string | $token | The session identifier |
LexisNexisSourceSearchRequest | $query | The query for searching the sources |
ListAdvancedSearchSources | ( | $ | token | ) |
Lists the sources for the advanced search
string | $token | The token identifier public |
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
string | $token | The session identifier |
int | $feed_id | The feed identifier (null means all articles) [OPTIONAL] |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of articles to be retrieved from the first article(null means all articles) [OPTIONAL] |
int | $time_range_count | The number of days starting from time range (null means all articles) [OPTIONAL] |
ListAggregatedLatestnewsFeeds | ( | $ | token | ) |
Get the list of available feeds from latestnews aggregator
string | $token | The session identifier |
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
string | $token | The session identifier |
int | $feed_id | The feed identifier (null means all articles) [OPTIONAL] |
int | $time_range | The time range for articles in days (null means all articles) [OPTIONAL] |
int | $record_range_from | The number of the first article to be retrieved (null means all articles) [OPTIONAL] |
int | $record_range_no | The number of the first articles to be retrieved from the first article (null means all articles) [OPTIONAL] |
int | $time_range_count | The time range count for articles in days (null means all articles) [OPTIONAL] |
ListAggregatedRSSFeeds | ( | $ | token | ) |
ListClusters | ( | $ | token, |
$ | fetch_countries = null |
||
) |
Get the list of available clusters
string | $token | The session identifier |
boolean | $fetch_countries | If set to true, the method will also return the list of countries belonging to the region (default: false) [OPTIONAL] |
listContinents | ( | $ | token | ) |
Get the master list of continents
string | $token | The session identifier |
listCountries | ( | $ | token, |
$ | continent_id = null , |
||
$ | eu_members_only = null , |
||
$ | official_only = null , |
||
$ | region_id = null |
||
) |
Get the master list of countries
string | $token | The session identifier |
int | $continent_id | Restricts the list to a given Continent [OPTIONAL] |
boolean | $eu_members_only | If true, restricts the list to EU countries, if False, restricts it to NON-EU members [OPTIONAL] |
boolean | $official_only | It true, restricts the list to official countries, if False, restricts it to non official countries [OPTIONAL] |
int | $region_id | The official region identifier [OPTIONAL] |
listCountries2 | ( | $ | token, |
$ | continent_id = null , |
||
$ | eu_members_only = null , |
||
$ | official_only = null |
||
) |
Get the master list of countries
string | $token | The session identifier |
int | $continent_id | Restricts the list to a given Continent [OPTIONAL] |
boolean | $eu_members_only | If true, restricts the list to EU countries, if False, restricts it to NON-EU members [OPTIONAL] |
boolean | $official_only | It true, restricts the list to official countries, if False, restricts it to non official countries [OPTIONAL] |
listCrisisCorrespondents | ( | $ | token, |
$ | countries | ||
) |
Get the list of CrisisCorrepondents (eventually filtered on a list of countries)
string | $token | Session Identifier |
Country[] | $countries Country list filter [OPTIONAL] |
ListCrisisRoomUsers | ( | $ | token | ) |
List the crisis room users
string | $token | The session identifier |
listDelegations | ( | $ | token, |
$ | country | ||
) |
Get a list of all available delegations (eventually filtered by country)
listDelegations2 | ( | $ | token, |
$ | countries | ||
) |
Get a list of all available delegations (eventually filtered on a list of countries)
string | $token | Session identifier |
Country[] | $countries Country list filter |
ListEngines | ( | $ | token | ) |
ListFlavours | ( | $ | token | ) |
ListGlobalAtlasMaps | ( | $ | token, |
$ | country, | ||
$ | dayRange = null |
||
) |
Returns the list of maps for a country
string | $token | The session identifier |
Country | $country | The country for which to retrieve the map |
int | $dayRange | The days for which to retrieve the maps [OPTIONAL] |
ListHotSpots | ( | $ | token, |
$ | day = null |
||
) |
Get the list of hotspots for a day
string | $token | The session identifier |
int | $day | The day for which to retrieve the hotspots (null means the current date) [OPTIONAL] |
listIndarNewsletters | ( | $ | token | ) |
Get the list of available newsletters
string | $token | The session identifier |
ListLDAPCachedDepartments | ( | $ | token | ) |
List the LDAP departments from system cache
string | $token | The session identifier |
ListNewsletters | ( | $ | token, |
$ | category_id = null |
||
) |
Get the list of available newsletters
string | $token | The session identifier |
int | $category_id | The category identifier [OPTIONAL] |
listNewslettersCategories | ( | $ | token | ) |
Lists the newsletters categories
string | $token | The session identifier public |
ListNewStickerGroups | ( | $ | token | ) |
Lists the news stickers groups
string | $token | The session identifier |
listOfficialRegions | ( | $ | token, |
$ | continent_id | ||
) |
Gets a list of the official regions
string | $token | The session identifier |
int | $continent_id | The continent identifier [OPTIONAL] public |
ListQueries | ( | $ | token | ) |
ListQuickSearchSources | ( | $ | token | ) |
Get the list of quicksearch sources
string | $token | The session identifier |
ListRadioChannels | ( | $ | token, |
$ | category_id = null |
||
) |
List the Radio channels
string | $token | The session identifier |
integer | $category_id | The channel category [OPTIONAL] |
ListRadioChannelsCategories | ( | $ | token | ) |
List the Radio channels category
string | $token | The session identifier |
listRegions | ( | $ | token, |
$ | fetch_countries = null |
||
) |
Get the list of all regions
string | $token | The session identifier |
boolean | $fetch_countries | If set to true, the method will also return the list of countries belonging to the region (default: false) [OPTIONAL] |
ListSources | ( | $ | token | ) |
ListSystemCachedUsers | ( | $ | token, |
$ | department = null |
||
) |
Gets a list of users from the system cache
string | $token | The session identifier |
string | $department | The LDAP departments from which to list the users [OPTIONAL] |
ListThemes | ( | $ | token, |
$ | no_texts = false |
||
) |
Get the list of available themes
string | $token | The session identifier |
boolean | $no_texts | If true, do not fetch the texts [OPTIONAL] |
ListThemeTopics | ( | $ | token, |
$ | theme_id | ||
) |
Lists the topics for a given theme
string | $token | The session identifier |
int | $theme_id | The theme identifier |
ListThemeTopicsWithQueries | ( | $ | token, |
$ | theme_id | ||
) |
List the topics themes with queries
string | $token | The session identifier |
int | $theme_id | The theme identifier |
ListThemeUsers | ( | $ | token, |
$ | theme_id | ||
) |
Lists the theme users
string | $token | The session identifier |
int | $theme_id | The theme identifier |
ListTopicQueries | ( | $ | token, |
$ | topic_id | ||
) |
Lists the queries for a theme topic
string | $token | The session identifier |
int | $topic_id | The topic identifier |
ListTVChannels | ( | $ | token, |
$ | category_id = null |
||
) |
List the TV channels
string | $token | The session identifier |
integer | $category_id | The channel category [OPTIONAL] |
ListTVChannelsCategories | ( | $ | token | ) |
List the TV channels category
string | $token | The session identifier |
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)
string | $token | The session identifier |
string | $channel | Channel name (* wildcard supported) [OPTIONAL] |
int | $start_date | Start date (unix timestamp) [OPTIONAL] |
int | $end_date | End date (unix timestamp) [OPTIONAL] |
string | $title | Program title (* wildcard supported) [OPTIONAL] |
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
string | $token | The session identifier |
int | $first_record | Number of the first record to return (default 0) [OPTIONAL] |
int | $record_count | Number of records to return (default all) [OPTIONAL] |
string | $channel | Channel name (* wildcard supported) [OPTIONAL] |
int | $start_date | Start date (unix timestamp) [OPTIONAL] |
int | $end_date | End date (unix timestamp) [OPTIONAL] |
string | $title | Program title (* wildcard supported) [OPTIONAL] |
oxanAuthenticate | ( | $ | token | ) | [protected] |
Authenticate with Oxford Analytica
string | $token | Session Identifier |
oxanCountryProfileURL | ( | $ | country | ) |
oxanDetailedSearch | ( | $ | token, |
$ | query | ||
) |
Search Oxford Analytica
string | $token | Session Identifier |
OxfordAnalyticaDetailedQuery | $query |
oxanFetchDocument | ( | $ | token, |
$ | documentId | ||
) |
Fetch a document from the Oxford Analytica engine
string | $token | Session Identifier |
string | $documentId | The Oxan document identifier |
oxanFetchUrl | ( | $ | token, |
$ | relative_url | ||
) |
Fetch a document from the Oxford Analytica engine
string | $token | Session Identifier |
string | $documentId | The Oxan document identifier |
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!
string | $oxan_url | The Oxford Analytica URL |
Get the "static" list of countries as defined in Oxford Analytica documentation
Get the "static" list of topics as defined in Oxford Analytica documentation
oxanParsePage | ( | $ | html | ) | [protected] |
Parse a page from Oxford Analytica
string | $html | The html page |
oxanSearch | ( | $ | token, |
$ | simpleQuery = null , |
||
$ | detailedQuery = null |
||
) | [protected] |
Runs a search amongst OxfordAnalytica articles
string | $token | Session Identifier |
OxfordAnalyticaSimpleQuery|null | Simple query or null if detailed query is used | |
OxfordAnalyticaDetailedQuery|null | Detailed query or null if simple query is used |
oxanSimpleSearch | ( | $ | token, |
$ | query | ||
) |
Search Oxford Analytica
string | $token | Session Identifier |
OxfordAnalyticaSimpleQuery | $query |
saveNewsletter | ( | $ | token, |
$ | newsletter | ||
) |
Saves or updates a newsletter into the database database (for insert, just set the newsletter_id to null)
string | $token | The session identifier |
Newsletter | $newsletter | The newsletter public |
sendMail | ( | $ | to, |
$ | sujet, | ||
$ | contenu, | ||
$ | attachments, | ||
$ | cc, | ||
$ | bcc | ||
) |
Send an e-mail message to a list of recipients
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] |
SetServerVariable | ( | $ | token, |
$ | key, | ||
$ | value | ||
) |
Save a variable in the server's persistent storage
string | $token | Session identifier |
string | $key | Variable name (255 characters max) |
string | $value | Value |
SetServerVariables | ( | $ | token, |
$ | variables | ||
) |
Set all server variables at once
string | $token | The session identifier |
Pair[] | $variables The list of variables |
SetThemeText | ( | $ | token, |
$ | theme_id, | ||
$ | short_text, | ||
$ | long_text | ||
) |
Sets the short text and long text of a theme
string | $token | The session identifier |
int | $theme_id | The theme identifier |
string | $short_text | The short text |
string | $long_text | The long text |
SetThemeUserDefinedQuery | ( | $ | token, |
$ | theme_id, | ||
$ | query | ||
) |
Sets the user defined query for the theme
string | $token | The session identifier |
int | $theme_id | The theme identifier |
Query | $query | The query |
SetUserPersistentVariable | ( | $ | token, |
$ | key, | ||
$ | value | ||
) |
Save a variable in the user's persistent storage
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
string | $value | The variable's value |
SetUserPersistentVariables | ( | $ | token, |
$ | variables | ||
) |
Set all user's persistent variables at once
string | $token | The session identifier |
Pair[] | $variables The list of variables |
SetUserSessionVariable | ( | $ | token, |
$ | key, | ||
$ | value | ||
) |
Save a variable in the user's session
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
string | $value | The variable's value |
SetUserSessionVariables | ( | $ | token, |
$ | variables | ||
) |
Set all user's session variables at once
string | $token | The session identifier |
Pair[] | $variables The list of variables |
SetUserVariable | ( | $ | token, |
$ | key, | ||
$ | value, | ||
$ | persistent = false |
||
) | [protected] |
Save a variable in the user's session
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
string | $value | The variable's value |
boolean | $persistent | If false (default) look for the value in the session, otherwise look in the persistent data of the user |
SetUserVariables | ( | $ | token, |
$ | variables, | ||
$ | persistent = false |
||
) | [protected] |
Save all variables in the user's session or persistent storage at once
string | $token | The session identifier |
Pair[] | $variables The list of variables | |
boolean | $persistent | If false (default) look for the value in the session, otherwise look in the persistent data of the user |
UpdateAggregatedLatestnewsFeed | ( | $ | token, |
$ | feed | ||
) |
Updates an existing Latestnews Feed
string | $token | The session identifier |
Latestnews_feed | $feed | The new feed to be inserted in the database |
UpdateAggregatedRSSFeed | ( | $ | token, |
$ | feed | ||
) |
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
int | $first_record | Number of the first record to return (default 0) [OPTIONAL] |
int | $record_count | Number of records to return (default all) [OPTIONAL] |
string | $channel | Channel name (* wildcard supported) [OPTIONAL] |
int | $start_date | Start date (unix timestamp) [OPTIONAL] |
int | $end_date | End date (unix timestamp) [OPTIONAL] |
string | $title | Program title (* wildcard supported) [OPTIONAL] |
VirageGetDocument | ( | $ | token, |
$ | document_id, | ||
$ | getImages | ||
) |
Get a Virage document
string | $token | The session identifier |
int | $document_id | The document identifier |
boolean | $getImages | If true, then it also returns the document images |
VirageGetDocumentAllImages | ( | $ | token, |
$ | document_id, | ||
$ | type, | ||
$ | getContent, | ||
$ | cache, | ||
$ | document = null |
||
) |
Gets all the images from a document
string | $token | The session identifier |
string | $document_id | The document identifier |
string | $type | The type of image to retrieve (small or big) |
boolean | $getContent | If set to false, do not retrieve the image content [OPTIONAL] |
boolean | $cache | If set to true, also cache the image [OPTIONAL] |
VirageDocument | $document | The document [OPTIONAL] public |
VirageGetDocumentHeadlines | ( | $ | token | ) |
Gets all the headlines of a video document
string | $token | The session identifier public |
VirageGetDocumentImages | ( | $ | token, |
$ | document_id | ||
) |
Get a Virage document images
string | $token | The session identifier |
int | $document_id | The document identifier |
VirageGetFullText | ( | $ | token, |
$ | document_id, | ||
$ | document = null |
||
) |
Get the full text of a video document
string | $token | The session identifier |
string | $document_id | The document identifier |
VirageDocument | $document | The document [OPTIONAL] public |
VirageGetWords | ( | $ | token, |
$ | document_id, | ||
$ | complete = true , |
||
$ | document = null |
||
) |
Gets the list of words
string | $token | The session identifier |
string | $document_id | The document identifier |
boolean | $complete | If set to true, get the words for the entire movie [OPTIONAL] |
VirageDocument | $document | The document [OPTIONAL] public |
VirageSearch | ( | $ | token, |
$ | query | ||
) |
Search for a video in the database using Virage
string | $token | The session identifier |
VirageSearchQuery | $query | The query to be executed |
VirageSearch2 | ( | $ | token, |
$ | query | ||
) |
Search for a video in the database using Virage and returns the complete document without the images
string | $token | The session identifier |
VirageSearchQuery | $query | The query to be executed |
WSK2LN_BrowseSourcesResponse | ( | $ | object, |
$ | folderId = null |
||
) | [protected] |
Converts a WSKBrowseSourcesResponse into a LexisNexisBrowseSourcesResponse
WSKBrowseSourcesResponse | $object | Response object |
int | $folderId | ID of the folder currently browsed |
WSKAuthenticate | ( | ) | [protected] |
Establish a connection with the LexisNexis WSK and return the security token (might be cached for performance reasons)
WSKBrowseSources | ( | $ | folderId = null | ) | [protected] |
Get a list of available Sources
int | $folderId | [OPTIONAL] |
$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" |