Constructs a tariqaThemes Object
Tariqa
__construct
(
$config,
$soap)
Get the content of a cluster
Cluster
GetCluster
(
string $token,
int $cluster_id)
-
string
$token: The session identifier
-
int
$cluster_id: The cluster identifier
Get the information about a continent
Continent
getContinent
(
string $token,
int $continent_id)
-
string
$token: The session identifier
-
int
$continent_id: Id of the continent
Get the information about a country identified by a code
Country
getCountry
(
string $token,
string $iso2,
string $iso3,
int $isonum,
string $comref,
string $sysper,
string $iana,
string $ioc,
string $un,
string $itu,
string $oxan_id,
string $comref_del)
-
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]
Get a list of maps for a given country
DMAMap[]
GetCountryMaps
(
string $token,
Country $country,
int $day_range)
-
string
$token: The session identifier
-
Country
$country: The country to search for
-
int
$day_range: The maximum age of the maps in days [OPTIONAL]
Get the number of articles per day for the selected countries
CountryStatisticsResult[]
GetCountryStatisticsPerDay
(string $token, Country[] $countries, [int $startDate = null], [int $endDate = null])
-
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]
Get the number of articles per hour for the selected countries
CountryStatisticsResult[]
GetCountryStatisticsPerHour
(string $token, Country[] $countries, [int $date = null])
-
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]
Get the information about a region
Region
getRegion
(
string $token,
int $region_id)
-
string
$token: The session identifier
-
int
$region_id: Id of the region
Get the master list of regions (Regions containing regions I.E: Continents)
MainRegion[]
getRegionList
(string $token, [int $level = null])
-
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]
Get the reliefweb maps for a country
ReliefWebMap[]
GetReliefWebMaps
(string $token, string $country_id)
-
string
$token: The session identifier
-
string
$country_id: The country ISO2 code
Get the list of available clusters
Cluster[]
ListClusters
(string $token, [boolean $fetch_countries = null])
-
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]
Get the master list of continents
Continent[]
listContinents
(string $token)
-
string
$token: The session identifier
Get the master list of countries
Country[]
listCountries
(string $token, [int $continent_id = null], [boolean $eu_members_only = null], [boolean $official_only = null])
-
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]
Get the master list of countries
Country2[]
listCountries2
(string $token, [int $continent_id = null], [boolean $eu_members_only = null], [boolean $official_only = null])
-
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]
Get the list of all regions
Region[]
listRegions
(string $token, [boolean $fetch_countries = null])
-
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]
Get the information about a country identified by a code
Country
_getCountry
([
string $iso2 =
null], [
string $iso3 =
null], [
int $isonum =
null], [
string $comref =
null], [
string $sysper =
null], [
string $iana =
null], [
string $ioc =
null], [
string $un =
null], [
string $itu =
null], [
string $oxan_id =
null], [
string $comref_del =
null])
-
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]
void
_getMainRegionCountriesList
()
void
_getMainRegionList
()
void
_getMainRegionSubRegionsList
()