Class tariqaCountry

Description

Located in /Tariqa.code/tariqaCountry.class.php (line 2)

Tariqa
   |
   --tariqaCountry
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
Cluster GetCluster (string $token, int $cluster_id)
Continent getContinent (string $token, int $continent_id)
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)
DMAMap[] GetCountryMaps (string $token, Country $country, int $day_range)
CountryStatisticsResult[] GetCountryStatisticsPerDay (string $token, Country[] $countries, [int $startDate = null], [int $endDate = null])
CountryStatisticsResult[] GetCountryStatisticsPerHour (string $token, Country[] $countries, [int $date = null])
Region getRegion (string $token, int $region_id)
MainRegion[] getRegionList (string $token, [int $level = null])
ReliefWebMap[] GetReliefWebMaps (string $token, string $country_id)
Cluster[] ListClusters (string $token, [boolean $fetch_countries = null])
Continent[] listContinents (string $token)
Country[] listCountries (string $token, [int $continent_id = null], [boolean $eu_members_only = null], [boolean $official_only = null])
Country2[] listCountries2 (string $token, [int $continent_id = null], [boolean $eu_members_only = null], [boolean $official_only = null])
Region[] listRegions (string $token, [boolean $fetch_countries = null])
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])
Variables
array $config = null (line 8)

Configuration array

  • access: protected
boolean $soap (line 14)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 21)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
GetCluster (line 885)

Get the content of a cluster

  • access: public
Cluster GetCluster (string $token, int $cluster_id)
  • string $token: The session identifier
  • int $cluster_id: The cluster identifier
getContinent (line 504)

Get the information about a continent

  • access: public
Continent getContinent (string $token, int $continent_id)
  • string $token: The session identifier
  • int $continent_id: Id of the continent
getCountry (line 338)

Get the information about a country identified by a code

  • access: public
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]
GetCountryMaps (line 33)

Get a list of maps for a given country

  • access: public
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]
GetCountryStatisticsPerDay (line 178)

Get the number of articles per day for the selected countries

  • access: public
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]
GetCountryStatisticsPerHour (line 189)

Get the number of articles per hour for the selected countries

  • access: public
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]
getRegion (line 809)

Get the information about a region

  • access: public
Region getRegion (string $token, int $region_id)
  • string $token: The session identifier
  • int $region_id: Id of the region
getRegionList (line 550)

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

  • access: public
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]
GetReliefWebMaps (line 1043)

Get the reliefweb maps for a country

  • access: public
ReliefWebMap[] GetReliefWebMaps (string $token, string $country_id)
  • string $token: The session identifier
  • string $country_id: The country ISO2 code
ListClusters (line 961)

Get the list of available clusters

  • access: public
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]
listContinents (line 461)

Get the master list of continents

  • access: public
Continent[] listContinents (string $token)
  • string $token: The session identifier
listCountries (line 201)

Get the master list of countries

  • access: public
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]
listCountries2 (line 271)

Get the master list of countries

  • access: public
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]
listRegions (line 726)

Get the list of all regions

  • access: public
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]
_getCountry (line 362)

Get the information about a country identified by a code

  • access: protected
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]
_getMainRegionCountriesList (line 641)
  • access: protected
void _getMainRegionCountriesList ()
_getMainRegionList (line 575)
  • access: protected
void _getMainRegionList ()
_getMainRegionSubRegionsList (line 598)
  • access: protected
void _getMainRegionSubRegionsList ()

Documentation generated on Thu, 10 Dec 2009 15:21:46 +0100 by phpDocumentor 1.4.1