Index of all elements
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ n ]
[ o ]
[ p ]
[ ]
[ s ]
[ t ]
[ u ]
[ w ]
[ x ]
a
- $attributes
- in file Geocache.inc.php, variable Geocache::$attributes
An array of attribute values as an associative array.
- addCacheToDB
- in file PHPGeocache.inc.php, method PHPGeocache::addCacheToDB()
Accepts only a Geocache object as a parameter and inserts that geocache object into the database.
top
c
- $city
- in file Geocache.inc.php, variable Geocache::$city
The name of the city where the cache is located. Normal capitalization is used here,
- $country
- in file Geocache.inc.php, variable Geocache::$country
The country where the cache can be found in the two-letter-format as defined by ISO 3166-1-alpha-2, e.g. "us" for the United States, "de" for Germany, "fr" for France and so on.
- close
- in file db-mysql.inc.php, method GeocacheDB::close()
Closes the MySQL connection.
- connect
- in file db-mysql.inc.php, method GeocacheDB::connect()
Establishes a connection to the database server given and selects the database given.
top
d
- $description
- in file Geocache.inc.php, variable Geocache::$description
A short textual description of the cache and further information on the surroundings if available.
- $difficulty
- in file Geocache.inc.php, variable Geocache::$difficulty
This is an integer value between 1 and 10 indicating the difficulty of the complete hike, i.e. how easy it is to find the cache.
- $duration
- in file Geocache.inc.php, variable Geocache::$duration
The _estimated_ duration of the complete hike in minutes.
- db-mysql.inc.php
- procedural page db-mysql.inc.php
- delete
- in file db-mysql.inc.php, method GeocacheDB::delete()
Used for executing DELETE statements. Returns the last AUTOINCREMENT value.
top
top
f
- $fields
- in file Geocache.inc.php, variable Geocache::$fields
Defines all fields given here for data import functions.
- findCaches
- in file PHPGeocache.inc.php, method PHPGeocache::findCaches()
Finds caches by searching in both the title and description fields.
- free
- in file Waypoint.inc.php, method Waypoint::free()
- free
- in file Geocache.inc.php, method Geocache::free()
Cleanup function which clears all values of this object.
top
g
- Geocache
- in file Geocache.inc.php, class Geocache
Defines the Geocache class.
- Geocache
- in file Geocache.inc.php, method Geocache::Geocache()
The PHP4 constructor
- Geocache.inc.php
- procedural page Geocache.inc.php
- GeocacheDB
- in file db-mysql.inc.php, method GeocacheDB::GeocacheDB()
The PHP4 constructor.
- GeocacheDB
- in file db-mysql.inc.php, class GeocacheDB
MySQL functions for PHPGeocache
- geoDistance
- in file Geocache.inc.php, method Geocache::geoDistance()
Calculates the distance between two coordinates for distances under a few kilometers.
- getAll
- in file db-mysql.inc.php, method GeocacheDB::getAll()
Executes the given SQL statement and returns all rows from the result set as an associative array.
- getAllByField
- in file db-mysql.inc.php, method GeocacheDB::getAllByField()
Executes the given SQL statement and returns a one-dimensional array containing all values of the given field in all all rows from the result set
- getCacheByID
- in file PHPGeocache.inc.php, method PHPGeocache::getCacheByID()
Returns a cache object by the cache_id field value of the caches table given.
- getCacheByName
- in file PHPGeocache.inc.php, method PHPGeocache::getCacheByName()
Returns a cache object by the name field value of the caches table given.
- getCachesByDistance
- in file PHPGeocache.inc.php, method PHPGeocache::getCachesByDistance()
Returns an array of Geocache objects sorted by distance to the location provided.
- getCoordinates
- in file Waypoint.inc.php, method Waypoint::getCoordinates()
Getter method for the attributes $long and $lat.
- getDescription
- in file Waypoint.inc.php, method Waypoint::getDescription()
Getter method for the attribute $description.
- getGPX
- in file Geocache.inc.php, method Geocache::getGPX()
If this object has at least a name, title, longitude and latitude set this function can return GPX code ("GPS Exchange Format") for this cache. This format is used by many programs working with GPS data.
- getHikeLength
- in file Geocache.inc.php, method Geocache::getHikeLength()
Returns the length of the complete hike in kilometers by adding the distances of each route from one waypoint to the next.
- getHint
- in file Waypoint.inc.php, method Waypoint::getHint()
Getter method for the attribute $hint.
- getKML
- in file Geocache.inc.php, method Geocache::getKML()
If this object has at least a name, title, longitude and latitude set this function can return KML code ("Keyhole Markup Language") for this cache. This format is used by Google Earth.
- getLinearDistances
- in file Geocache.inc.php, method Geocache::getLinearDistances()
Returns the distances of each single route between one waypoint and the next excluding parking waypoints.
- getLOC
- in file Geocache.inc.php, method Geocache::getLOC()
If this object has at least a name, title, url, longitude and latitude set this function can return LOC code for this cache. This format is used mainly on Geocaching.com.
- getName
- in file Waypoint.inc.php, method Waypoint::getName()
Getter method for the attribute $name.
- getOCF
- in file Geocache.inc.php, method Geocache::getOCF()
This function returns OCF code ("OpenCacheFormat") for this cache.
- getOne
- in file db-mysql.inc.php, method GeocacheDB::getOne()
Executes the given SQL statement and returns only the first row from the result set.
- getOneField
- in file db-mysql.inc.php, method GeocacheDB::getOneField()
Executes the given SQL statement and returns only the value of the field given from the first row from the result set.
- getPointType
- in file Waypoint.inc.php, method Waypoint::getPointType()
Getter method for the attribute $pointtype.
- getPublic
- in file Waypoint.inc.php, method Waypoint::getPublic()
Getter method for the attribute $public.
- getRealWaypoints
- in file Geocache.inc.php, method Geocache::getRealWaypoints()
Returns an array of all waypoints of this geocache which are not parking waypoints.
- getTitle
- in file Waypoint.inc.php, method Waypoint::getTitle()
Getter method for the attribute $title.
- greatCircleDistance
- in file Geocache.inc.php, method Geocache::greatCircleDistance()
Calculates the distance between two coordinates for distances greater than a few kilometers.
top
h
- $homepage
- in file Geocache.inc.php, variable Geocache::$homepage
The URL of the cache homepage. This field is mostly empty unless someone has created a specific website just for this cache or a cache series. This might happen if it is an event cache. Please note: this is _not_ the URL of the website where the data was obtained from.
top
i
- insert
- in file db-mysql.inc.php, method GeocacheDB::insert()
Used for executing INSERT statements. Returns the last AUTOINCREMENT value.
top
l
- $lang
- in file PHPGeocache.inc.php, variable PHPGeocache::$lang
The language.
- $lang
- in file Geocache.inc.php, variable Geocache::$lang
The ISO 639-1 code of the language of the description of the geocache and all additional texts, e.g. "en" for English and "de" for German.
- $lastError
- in file db-mysql.inc.php, variable GeocacheDB::$lastError
The last error which occured.
- $lastError
- in file Geocache.inc.php, variable Geocache::$lastError
Contains a textual description of the last error that occured.
- $lastError
- in file OCFParser.inc.php, variable OCFParser::$lastError
Contains a textual description of the last error that occured.
- $lat
- in file Geocache.inc.php, variable Geocache::$lat
The latitude in decimal form of the cache location to be displayed, e.g. 51.7064.
- $length
- in file Geocache.inc.php, variable Geocache::$length
The complete hike length in meters (not in miles). To convert miles to kilometers you simply have to multiply the miles by 1.609344.
- $logurl
- in file Geocache.inc.php, variable Geocache::$logurl
The URL where the log for this geocache can be accessed.
- $long
- in file Geocache.inc.php, variable Geocache::$long
The longitude in decimal form of the cache location to be displayed, e.g. 7.18574.
- loadCacheFromOCF
- in file Geocache.inc.php, method Geocache::loadCacheFromOCF()
Loads a single cache from an OCF file and parses the content into this object.
top
n
- $name
- in file Geocache.inc.php, variable Geocache::$name
The unique name of the cache. This is a string with a length of max. 6 characters.
top
o
- $ocfAttributes
- in file Geocache.inc.php, variable Geocache::$ocfAttributes
Defines all attributes of the OpenCacheFormat.
- $owner
- in file Geocache.inc.php, variable Geocache::$owner
The name of the owner of the cache. This _must_ be the name of the registered user on the website from which the cache information was obtained which is listed as the owner on the corresponding page.
- OCFParser
- in file OCFParser.inc.php, class OCFParser
Defines the OCFParser class.
- OCFParser.inc.php
- procedural page OCFParser.inc.php
top
p
- $placed
- in file Geocache.inc.php, variable Geocache::$placed
The date when the cache was placed as UNIX timestamp.
- parse
- in file OCFParser.inc.php, method OCFParser::parse()
Parses the OCF file given and returns an array containing the OCF data.
- PHPGeocache
- in file PHPGeocache.inc.php, class PHPGeocache
Defines the PHPGeocache class.
- PHPGeocache
- in file PHPGeocache.inc.php, method PHPGeocache::PHPGeocache()
The PHP4 constructor
- PHPGeocache.inc.php
- procedural page PHPGeocache.inc.php
- PHPGEOCACHE_CLASS_PATH
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_CLASS_PATH
Defines the correct class path automatically.
- PHPGEOCACHE_DB_DB
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_DB_DB
- PHPGEOCACHE_DB_PASSWORD
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_DB_PASSWORD
- PHPGEOCACHE_DB_SERVER
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_DB_SERVER
- PHPGEOCACHE_DB_TYPE
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_DB_TYPE
Default database settings.
- PHPGEOCACHE_DB_USER
- in file PHPGeocache.inc.php, constant PHPGEOCACHE_DB_USER
top
top
s
- $size
- in file Geocache.inc.php, variable Geocache::$size
The size of the cache. This string must be in lower case and may only be one the the following:
- $src
- in file Geocache.inc.php, variable Geocache::$src
The source where this geocache was obtained from, e.g. "OPENCACHING.DE"
- $srcid
- in file Geocache.inc.php, variable Geocache::$srcid
The source ID of the geocache. If used in conjunction with the PHPGeocache class the srcid will always be the autoincrement value of the caches table - the field "cache_id".
- $state
- in file Geocache.inc.php, variable Geocache::$state
The name of the state in the locally defined short form, i.e. in the US it is a two-letter-code like "va" for Virginia, "ny" for "New York" and so on.
- sendGPX
- in file Geocache.inc.php, method Geocache::sendGPX()
Sends the data of this object as a GPX file with the corresponding MIME type directly to the userīs browser prompting him to download the file.
- sendKML
- in file Geocache.inc.php, method Geocache::sendKML()
Sends the data of this object as a KML file with the corresponding MIME type directly to the userīs browser prompting him to download the file.
- sendLOC
- in file Geocache.inc.php, method Geocache::sendLOC()
Sends the data of this object as a LOC file with the corresponding MIME type directly to the userīs browser prompting him to download the file.
- sendOCF
- in file Geocache.inc.php, method Geocache::sendOCF()
Sends the data of this object as a OCF file with the corresponding MIME type directly to the userīs browser prompting him to download the file.
- setCoordinates
- in file Waypoint.inc.php, method Waypoint::setCoordinates()
Setter method for the attributes $long and $lat If the given value is invalid the complete object is emptied.
- setDescription
- in file Waypoint.inc.php, method Waypoint::setDescription()
Setter method for the attribute $description.
- setErrorMode
- in file PHPGeocache.inc.php, method PHPGeocache::setErrorMode()
Sets the error mode, whether errors should be displayed or logged or both.
- setHint
- in file Waypoint.inc.php, method Waypoint::setHint()
Setter method for the attribute $hint.
- setName
- in file Waypoint.inc.php, method Waypoint::setName()
Setter method for the attribute $name.
- setPointType
- in file Waypoint.inc.php, method Waypoint::setPointType()
Setter method for the attribute $pointtype.
- setPublic
- in file Waypoint.inc.php, method Waypoint::setPublic()
Setter method for the attribute $public.
- setTitle
- in file Waypoint.inc.php, method Waypoint::setTitle()
Setter method for the attribute $title.
top
t
- $targetDistance
- in file Geocache.inc.php, variable Geocache::$targetDistance
This value is only set from other external functions.
- $terrain
- in file Geocache.inc.php, variable Geocache::$terrain
This is an integer value between 1 and 10 indicating the difficulty of the complete hike, i.e. how easy it is to reach the cache. On the website http://www.clayjar.com/gcrs/ you can calculate the difficulty, but please note that the value here has a maximum value of 10.
- $title
- in file Geocache.inc.php, variable Geocache::$title
The title of the cache. This is normally referred to as "the name of the cache".
- $type
- in file Geocache.inc.php, variable Geocache::$type
The type of the cache. This string must be in lower case and may only be one the the following:
top
u
- $url
- in file Geocache.inc.php, variable Geocache::$url
The URL where this geocache is listed. This URL should link directly to the page of the cache, not to the homepage of that website.
- update
- in file db-mysql.inc.php, method GeocacheDB::update()
Used for executing UPDATE statements. Returns the number of affected rows.
top
w
- $waypoints
- in file Geocache.inc.php, variable Geocache::$waypoints
An array of Waypoint objects. Each entry is an instantiation of the Waypoint class.
- Waypoint
- in file Waypoint.inc.php, class Waypoint
Defines Waypoint class.
- Waypoint
- in file Waypoint.inc.php, method Waypoint::Waypoint()
The PHP4 constructor
- Waypoint.inc.php
- procedural page Waypoint.inc.php
top
x
- xmlPrep
- in file Geocache.inc.php, method Geocache::xmlPrep()
Automatically inserts the sring given in CDATA tags if it contains otherwise forbidden characters.
top
top
|
|
