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

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

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_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
_getMainRegionCountriesList ( ) [protected]
_getMainRegionList ( ) [protected]
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_maps = false,
get_wiki = false 
)

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]
boolean$get_mapsIf set to true, return also the Maps of the country [OPTIONAL]
boolean$get_wikiIf set to true, also return the Wikipedia country profile data [OPTIONAL]
Returns:
Country
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

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]
boolean$get_mapsIf set to true, return also the Maps of the country [OPTIONAL]
boolean$get_wikiIf set to true, also return the Wikipedia country profile data [OPTIONAL]
Returns:
string
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[]
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[]
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[]
GetReliefWebMaps ( token,
country_id 
)

Get the reliefweb maps for a country

Parameters:
string$tokenThe session identifier
string$country_idThe country ISO2 code
Returns:
ReliefWebMap[]
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,
group = false 
)

Get the master list of continents

Parameters:
string$tokenThe session identifier
boolean$groupIf true, group Oceania and Antarctica [OPTIONAL]
Returns:
Continent[]
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

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]
string[]$country_ids A list of country ids [OPTIONAL]
boolean$groupIf true, group Oceania + Antarctica [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[]
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[]
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[]

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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