| plugins_geo

# Class: Bs_GeoServer Source Location: /plugins/geo/Bs_GeoServer.class.php
### Class Overview
    Bs_Object
       |
       --Bs_GeoServer
terms used: #### Author(s): andrej arn <at blueshoes dot org> #### Version: 4.3.$Revision: 1.2 $ $Date: 2003/08/09 15:23:13 $ #### Copyright: blueshoes.org | ### Methods Bs_GeoServer getCapital getCoordForLocationByLocationId getCoordForLocationByLocationName getCoordinatesForCountry getCountryCodeByCountryString getCountryCodeByLocationId getCountryList getLocationList setDb
### Inherited Variables | ### Inherited Methods #### Class: Bs_Object Bs_Object::Bs_Object() Bs_Object::getErrors() Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack. Bs_Object::getLastError() Basic error handling: Get last error string from the global Bs_Error-error stack. Bs_Object::getLastErrors() Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors(). Bs_Object::persist() Persists this object by serializing it and saving it to a file with unique name. Bs_Object::setError() Basic error handling: Push an error string on the global Bs_Error-error stack. Bs_Object::toHtml() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::toString() Dumps the content of this object to a string using PHP's var_dump(). Bs_Object::unpersist() Fetches an object that was persisted with persist()
### Class Details [line 26] terms used: countryCode: the 2-letter iso country code, examples: us = united states, ca = canada, de = germany, ch = switzerland countryString: locationId: the ID of a named country, city, town or place, usually a city/town. dependencies: #### Tags:
version: | 4.3.$Revision: 1.2 $ $Date: 2003/08/09 15:23:13 $
copyright: | blueshoes.org
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Methods ### constructor Bs_GeoServer [line 41]
`Bs_GeoServer Bs_GeoServer( )`
constructor. [ Top ] ### method getCapital [line 103]
`string getCapital( string $countryCode)`
returns the name of the capital for the given country. #### Tags:
return: | (capitol name)
throws: | mixed (bs_exception if BsKb.CountryCapital is not installed or no db access, NULL if we can't tell because country unknown.)
access: | public
#### Parameters:
string | $countryCode |
[ Top ] ### method getCoordForLocationByLocationId [line 114]
`void getCoordForLocationByLocationId( mixed $locationId)`
[ Top ] ### method getCoordForLocationByLocationName [line 116]
`void getCoordForLocationByLocationName( mixed $locationName, mixed $country)`
[ Top ] ### method getCoordinatesForCountry [line 110]
`void getCoordinatesForCountry( mixed $countryCode)`
[ Top ] ### method getCountryCodeByCountryString [line 66]
`string getCountryCodeByCountryString( string $countryString)`
#### Tags:
return: | (country code)
throws: | NULL (if we can't tell, whatever reason it is.)
access: | public
#### Parameters:
string | $countryString |
[ Top ] ### method getCountryCodeByLocationId [line 92]
`void getCountryCodeByLocationId( mixed $locationId)`
[ Top ] ### method getCountryList [line 142]
`void getCountryList( mixed $lang)`
[ Top ] ### method getLocationList [line 145]
`void getLocationList( mixed $countryCode, [mixed $lang = 'en'])`
[ Top ] ### method setDb [line 55]
`void setDb( object &$dbObj)`
sets a db object for this class. if the global db object exists, the constructor sets it already for you. #### Tags:
access: | public
#### Parameters:
object | &$dbObj | (instance of a Bs_Db subclass, like Bs_MySql)
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:10:46 +0100 by phpDocumentor 1.2.3