Tariqa SOAP
|
Public Member Functions | |
__construct ($config, $soap) | |
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, $country_ids=null, $group=false) | |
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, $get_maps=false, $get_wiki=false) | |
getCountry3 ($token, $iso2, $iso3, $isonum, $comref, $sysper, $iana, $ioc, $un, $itu, $oxan_id, $comref_del, $get_maps=false, $get_wiki=false) | |
listContinents ($token, $group=false) | |
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) | |
Data Fields | |
$soap | |
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) | |
_getMainRegionList () | |
_getMainRegionSubRegionsList () | |
_getMainRegionCountriesList () | |
Protected Attributes | |
$config = null |
__construct | ( | $ | config, |
$ | soap | ||
) |
Constructs a tariqaThemes Object
_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] |
_getMainRegionCountriesList | ( | ) | [protected] |
_getMainRegionList | ( | ) | [protected] |
_getMainRegionSubRegionsList | ( | ) | [protected] |
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_maps = false , |
||
$ | get_wiki = false |
||
) |
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] |
boolean | $get_maps | If set to true, return also the Maps of the country [OPTIONAL] |
boolean | $get_wiki | If set to true, also return the Wikipedia country profile data [OPTIONAL] |
getCountry3 | ( | $ | token, |
$ | iso2, | ||
$ | iso3, | ||
$ | isonum, | ||
$ | comref, | ||
$ | sysper, | ||
$ | iana, | ||
$ | ioc, | ||
$ | un, | ||
$ | itu, | ||
$ | oxan_id, | ||
$ | comref_del, | ||
$ | get_maps = false , |
||
$ | get_wiki = false |
||
) |
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] |
boolean | $get_maps | If set to true, return also the Maps of the country [OPTIONAL] |
boolean | $get_wiki | If set to true, also return the Wikipedia country profile data [OPTIONAL] |
GetCountryMaps | ( | $ | token, |
$ | country, | ||
$ | day_range | ||
) |
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] |
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] |
GetReliefWebMaps | ( | $ | token, |
$ | country_id | ||
) |
Get the reliefweb maps for a country
string | $token | The session identifier |
string | $country_id | The country ISO2 code |
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, |
$ | group = false |
||
) |
Get the master list of continents
string | $token | The session identifier |
boolean | $group | If true, group Oceania and Antarctica [OPTIONAL] |
listCountries | ( | $ | token, |
$ | continent_id = null , |
||
$ | eu_members_only = null , |
||
$ | official_only = null , |
||
$ | region_id = null , |
||
$ | country_ids = null , |
||
$ | group = false |
||
) |
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] |
string[] | $country_ids A list of country ids [OPTIONAL] | |
boolean | $group | If true, group Oceania + Antarctica [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] |
listOfficialRegions | ( | $ | token, |
$ | continent_id | ||
) |
Gets a list of the official regions
string | $token | The session identifier |
int | $continent_id | The continent identifier [OPTIONAL] public |
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] |
$config = null [protected] |
Reimplemented from Tariqa.
$soap |
Reimplemented from Tariqa.