API functions from PGC towards the Sandbox. The sandbox is not allowed to use more than 1G memory or execute for longer than 60 seconds. More...

Static Public Member Functions
static	CollectErrors ($errno, $errstr, $errfile, $errline)

static	GetCollectedErrors ()

static	SetUserPremiumState ($premium)

static	SetQueueToken ($token)

static	AddOutput ($output)

static	GetOutput ()

static	Log ()
	Log a string that can be retrieved if the script timeouts. More...

static	GetFinds ($profileId, $params=array())
	Returns an associative array with the finds from given profileId. More...

static	GetHides ($profileId, $params=array())
	Returns an associative array with the hides from given profileId. More...

static	GetBookmarklist ($bmcode, $params=array())
	Retuns an array with gccodes from a bookmark list. More...

static	HTMLEscape ($string)
	Returns an HTML escaped string. More...

static	CreateHTMLTable ($data)
	Returns a HTML table created from the data you provide. More...

static	ProfileName2Id ($profileName)
	Returns the Profile ID of a user from given Profile name. More...

static	ProfileId2Name ($profileId)
	Returns the Profile name of a user from given Profile ID. More...

static	UTF8ToUpper ($string)
	Converts string to upper case. More...

static	UTF8ToLower ($string)
	Converts string to lower case. More...

static	UTF8SubStr ($string, $start, $length)
	Gets a part of a string. More...

static	UTF8StrLen ($string)
	Returns length of string. More...

static	Gccode2CacheName ($gccode)
	Returns a Cache name from a gccode. More...

static	DistanceVincenty ($latitude1, $longitude1, $latitude2, $longitude2)
	Returns distance in meters. More...

static	DistanceHaversine ($latitude1, $longitude1, $latitude2, $longitude2)
	Returns distance in meters. More...

static	GetPublishers ($profileId, $params=array())
	Retuns an associative array with cache_id, gccode, publisher_id, publisher_name, publish_date, visitdate, log_id for each find. More...

static	GetSouvenirs ($profileId, $params=array())
	Retuns an associative array with date_discovered, souvenir_guid, image_path, thumb_path, title, pgc_group for each souvenir. More...

static	GetFavorites ($favoriteType='points', $params=array())
	Retuns an associative array with cache data. More...

static	GetOldestCaches ($params=[])
	Retuns an associative array with cache data for the oldest geocaches according to the filter. Based on hidden date. More...

static	GetHighestCaches ($params=[])
	Retuns an associative array with cache data for the highest elevation geocaches according to the filter. Based on Project-GC's elevation data. More...

static	GetLowestCaches ($params=[])
	Retuns an associative array with cache data for the lowest elevation geocaches according to the filter. Based on Project-GC's elevation data. More...

static	GetAttributeList ()
	Get list of all known attributes. More...

static	GetNumTrackablesDiscovered ($profileId)
	Get number of discovered trackables. More...

static	GetMembershipCreatedDate ($profileId)
	Gets the date the user registered at Geocaching.com. More...

static	GetNumCachesInArea ($params)
	Gets the number of geocaches in a defined area. More...

static	GetBadgeGenDataV3 ($profileId, $params)
	Get BadgeGen (v3) badges and belt for specified user. More...

static	GetBadgeGenDataV4 ($profileId, $params=[])
	Get BadgeGen (v4) badges and belt for specified user. More...

static	GetJsonData ($lookupKey)
	Get a json blob from the PGC servers. More...

static	GetFPDetailsForUser ($profileId)
	Returns a list of all gccodes the user has favorited. More...

static	GetRegionNamesInCountry ($country)
	Returns a list of region names given a country. More...

static	GetCountyNamesInCountry ($country)
	Returns a list of county names given a country. More...

static	GetCountryPolygonInfo ($country)

static	GetRegionPolygonInfoFromCountry ($country)

static	GetCountyPolygonInfoFromCountry ($country)

static	GetCountyPolygonInfoFromRegion ($country, $region)

static	GetCountyNamesInRegion ($country, $region)
	Returns a list of county names given a country. More...

static	GetNumberOfRegionsInCountry ($country)
	Returns number of regions in a country. More...

static	GetNumberOfCountiesInCountry ($country)
	Returns number of counties in a country. More...

static	GetNumberOfCountiesInRegion ($country, $region)
	Returns number of counties in a region. More...

static	GetContinentDefinitions ($continent=FALSE)
	Get continent definitions. More...

static	GetLabCacheFinds ($profileId)
	Returns an associative array with the labcache finds from given profileId. More...

static	GetLonelyFinds ($profileId, $days, $params=[])
	Returns an associative array with finds on geocaches that haven't been found in $days days before the Geocacher found it. More...

static	GetIso3166_1alpha2Table ($flip=false)
	Returns an associative array with country-abbreviation as key and country name as value (or the opposite if flip is used) More...

static	GetFurthestFound ($profileId, $params=[])
	Get the furthest found from home. More...

static	Get360HomeBasicData ($profileId, $params=[])

static	GetPGCGeoJson ($level, $country, $regionNames=[], $countyNames=[], $landonly=false)
	Returns a list of GeoJSONs in string format. More...

static	GetCPUUsage ()
	Get number of cpu seconds according to the LUA Sandbox. More...

static	print ()
	Prints output into the Debug output window. More...

Public Attributes
const	MAXMEM = 102410241024

const	MAXCPUTIME = 60

Static Public Attributes
static	$sandbox = NULL

Detailed Description

API functions from PGC towards the Sandbox. The sandbox is not allowed to use more than 1G memory or execute for longer than 60 seconds.

Member Function Documentation

◆ CreateHTMLTable()

static PGC_LUA_Sandbox::CreateHTMLTable ( $data )

static

Returns a HTML table created from the data you provide.

At this point, there is no options to design the table. Neither can headers be provided. It's WIP.

Parameters

[in] array $data An associative array of the data you want back as HTML.

Returns: An HTML string with the data.

◆ DistanceHaversine()

static PGC_LUA_Sandbox::DistanceHaversine	(	$latitude1,
		$longitude1,
		$latitude2,
		$longitude2
	)

static

Returns distance in meters.

Returns distance between two set of coordinates according to the Haversine formula. Haversine is less accurate than Vincenty. Will return false if one of the input parameters is false. False on coordinates is used for premium only geocaches for non premium users.

Parameters

[in]	float	$latitude1
[in]	float	$longitude1
[in]	float	$latitude2
[in]	float	$longitude2

Returns: Distance between the coordinates in meters, as a float.

◆ DistanceVincenty()

static PGC_LUA_Sandbox::DistanceVincenty	(	$latitude1,
		$longitude1,
		$latitude2,
		$longitude2
	)

static

Returns distance in meters.

Returns distance between two set of coordinates according to the Vincenty formula. Vincenty is more accurate than Haversine. Will return false if one of the input parameters is false. False on coordinates is used for premium only geocaches for non premium users.

Parameters

[in]	float	$latitude1
[in]	float	$longitude1
[in]	float	$latitude2
[in]	float	$longitude2

Returns: Distance between the coordinates in meters, as a float.

◆ Gccode2CacheName()

static PGC_LUA_Sandbox::Gccode2CacheName ( $gccode )

static

Returns a Cache name from a gccode.

Parameters

[in] string $gccode The gccode (GCxxxxx).

Returns: The cache name as a string, or false if the cache isn't known.

◆ GetAttributeList()

static PGC_LUA_Sandbox::GetAttributeList ( )

static

Get list of all known attributes.

Returns: An associative array (attributeName, groupId, groupName, imageFaded, imageSet, imageUnset) with all known attributes, indexed by attribute id.

◆ GetBadgeGenDataV3()

static PGC_LUA_Sandbox::GetBadgeGenDataV3	(	$profileId,
		$params
	)

static

Get BadgeGen (v3) badges and belt for specified user.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array with extra options. excludeTraveling (bool): Defaults to true. Ignore geocaches listed in http://www.geocaching.com/bookmarks/view.aspx?code=BMAFMJR . excludeLocationless (bool): Defaults to true. Ignore geocaches of type locationless. NOT IMPLEMENTED

Returns: data array.

◆ GetBadgeGenDataV4()

static PGC_LUA_Sandbox::GetBadgeGenDataV4	(	$profileId,
		$params = `[]`
	)

static

Get BadgeGen (v4) badges and belt for specified user.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array with extra options. excludeTraveling (bool): Defaults to true. Ignore geocaches listed in http://www.geocaching.com/bookmarks/view.aspx?code=BMAFMJR . includeLabCaches (bool): Defaults to false. excludeLocationless (bool): Defaults to true. Ignore geocaches of type locationless. NOT IMPLEMENTED

Returns: data array.

◆ GetBookmarklist()

static PGC_LUA_Sandbox::GetBookmarklist	(	$bmcode,
		$params = `array()`
	)

static

Retuns an array with gccodes from a bookmark list.

Parameters

[in]	string	$bmcode	A bookmark list bmcode.
[in]	array	$params	An optional array of options. useCache (bool): Defaults to true, use cached list data if it exists. The cached data is never more than 1 hour old.

Returns: An associative array with the data.

◆ GetContinentDefinitions()

static PGC_LUA_Sandbox::GetContinentDefinitions ( $continent = FALSE )

static

Get continent definitions.

Returns an associative array with continents and their belonging countries. If the optional parameter continent is used, a list of countries are returned only.

Parameters

[in] string continent - Optional, if given, a list of countries for the given continent is returned

◆ GetCountryPolygonInfo()

static PGC_LUA_Sandbox::GetCountryPolygonInfo ( $country )

static

Parameters

[in] string country

◆ GetCountyNamesInCountry()

static PGC_LUA_Sandbox::GetCountyNamesInCountry ( $country )

static

Returns a list of county names given a country.

Parameters

[in] string country

◆ GetCountyNamesInRegion()

static PGC_LUA_Sandbox::GetCountyNamesInRegion	(	$country,
		$region
	)

static

Returns a list of county names given a country.

Parameters

[in]	string	country
[in]	string	region

◆ GetCountyPolygonInfoFromCountry()

static PGC_LUA_Sandbox::GetCountyPolygonInfoFromCountry ( $country )

static

Parameters

[in] string country

◆ GetCountyPolygonInfoFromRegion()

static PGC_LUA_Sandbox::GetCountyPolygonInfoFromRegion	(	$country,
		$region
	)

static

Parameters

[in]	string	country
[in]	string	region

◆ GetCPUUsage()

static PGC_LUA_Sandbox::GetCPUUsage ( )

static

Get number of cpu seconds according to the LUA Sandbox.

Returns: float

◆ GetFavorites()

static PGC_LUA_Sandbox::GetFavorites	(	$favoriteType = `'points'`,
		$params = `array()`
	)

static

Retuns an associative array with cache data.

Parameters

[in]	string	$favoriteType	Can be one of points, percentage, wilson. Defaults to points.
[in]	array	$params	An optional associative array of options for filtering/limit. limit (integer): Max number of rows to return (default=100, max=1000) dontCountArchivedTowardsLimit: (bool) defaults to true dontCountDisabledTowardsLimit: (bool) defaults to false alternativeDBCluster: (bool) defaults to false - Generally faster if processing lots of data, like multiple countries. Can not be combined with radius/distance filter. filter (array): An associative array with filters country (string or array) region (string or array) county (string or array) types (array): An array of valid types sizes (array): An array of valid sizes difficulties (array): An array of valid values terrains (array): An array of valid values excludeOwner (int): Exclude geocaches by this ownerId excludeDisabled (bool): Exclude disabled geocaches, defaults to false excludeArchived (bool): Exclude archived geocaches, defaults to false requiredFP (int): Required favorite points. Will default to 10 when using favoriteType = percentage, to match the top list, otherwise 0. Note that this is in pure points regardless of type, and not in percent or wilson score. radius (array): An associative array, the Haversine formula will be used distance (integer): Number of meters. latitude (float): Latitude. longitude (float): Longitude.

Returns: An associative array with the data.

◆ GetFinds()

static PGC_LUA_Sandbox::GetFinds	(	$profileId,
		$params = `array()`
	)

static

Returns an associative array with the finds from given profileId.

Coordinates for Premium geocaches will not be returned if the logged in user is not a Premium member with Groundspeak.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array of options for filtering/sorting/limit. limit (integer): Max number of rows to return excludeDupFinds (bool): Exclude duplicate finds on the same geocache. Only the oldest will be return. Defaults to false. excludeTravelingGeocaches (bool): Exclude geocaches listed in the offical BMAFMJR bookmark list. Defaults to false. includeLabCaches (bool): If set to true, will include labcache finds. Note that most fields returned will be null. The field cache_id is NOT guaranteed to be unique between geocaches and labcaches. Filters are ignored, even for dates. order: NEWESTFIRST to sort with the newest finds first, or OLDESTFIRST for the opposite fields (array): An array with fields names that you want in your return result. If you expect more than 5000 finds you more or less need to use this to decrease the memory usage. gccode, cache_id, cache_name, type, difficulty, terrain, size, owner_id, placed_by, latitude, longitude, elevation, hidden, last_publish_date, country, region, county, archived, disabled, premium, attributes_set, attributes_unset, last_find_date, last_archive_date, num_finds, latest_logs, favorite_points, favorite_points_pct, favorite_points_wilson, last_cache_harvest, last_log_harvest, log_id, visitdate, length, words, ftf, cache_description filter (array): An associative array with filters country (string or array) region (string or array) county (string or array) minVisitDate (string): YYYY-MM-DD, the date will be included, ie: >= date maxVisitDate (string): YYYY-MM-DD, the date will be included, ie: <= date minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date maxHiddenDate (string): YYYY-MM-DD, the date will be included, ie: <= date gccodes (array): List of gccodes types (array): An array of valid types sizes (array): An array of valid sizes difficulties (array): An array of valid values terrains (array): An array of valid values minFavoritePoints (int): Minimum amount of favorite points required minFavoritePointsPercent (int): Minimum amount of favorite points percent required minFavoritePointsWilson (int): Minimum amount of favorite points wilson score required monthnames (array): List of January/February/March/April/May/June/July/August/September/October/November/December daynames (array): List of Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday radius (array): An associative array algorithm (string): Can be any value of ['Vincenty', 'Haversine']. Defaults to 'Vincenty'. distance (integer): Number of meters. latitude (float): Latitude. longitude (float): Longitude. minMax (string): Can be any value of ['min', 'max']. Defaults to 'max'.

Returns: An associative array with the data.

◆ GetFPDetailsForUser()

static PGC_LUA_Sandbox::GetFPDetailsForUser ( $profileId )

static

Returns a list of all gccodes the user has favorited.

Since Project-GC does not detect FP changes very fast, this list might be quite inaccurate if the user has spent or removed favorite points without logging the geocaches lately.

Parameters

[in] int $profileId

Returns: An array of gccodes

◆ GetFurthestFound()

static PGC_LUA_Sandbox::GetFurthestFound	(	$profileId,
		$params = `[]`
	)

static

Get the furthest found from home.

If the user doesn't have home coordinates a value of FALSE will be returned.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array of options for filtering/sorting/limit. types (array): An array of valid cache types (defaults to all). excludeTypes (array): An array of invalid cache types (defaults to [Locationless (Reverse) Cache], set to [] to include all). excludeTraveling (bool): Defaults to true. Ignore geocaches listed in http://www.geocaching.com/bookmarks/view.aspx?code=BMAFMJR . ftfOnly (bool): Defaults to false. If true, considers logs that are FTF tagged. leapdayOnly (bool): Defaults to false. If true, considers logs on leapday only.

Returns: associative array with the following fields: gccode, distance (km), visitdate

◆ GetHides()

static PGC_LUA_Sandbox::GetHides	(	$profileId,
		$params = `array()`
	)

static

Returns an associative array with the hides from given profileId.

Coordinates for Premium geocaches will not be returned if the logged in user is not a Premium member with Groundspeak.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array of options for filtering/sorting/limit. limit (integer): Max number of rows to return fields (array): An array with fields names that you want in your return result. Use this to save memory. gccode, cache_id, cache_name, type, difficulty, terrain, size, placed_by, latitude, longitude, elevation, hidden, last_publish_date, country, region, county, archived, disabled, premium, attributes_set, attributes_unset, last_find_date, last_archive_date, num_finds, latest_logs, favorite_points, favorite_points_pct, favorite_points_wilson, last_log_harvest includeLogs (bool): If set to true, will return log data as well. Defaults to false.

Returns: An associative array with the data.

◆ GetHighestCaches()

static PGC_LUA_Sandbox::GetHighestCaches ( $params = [] )

static

Retuns an associative array with cache data for the highest elevation geocaches according to the filter. Based on Project-GC's elevation data.

Can return more than limit rows. Will first figure out the lowest elevation allowed, and then fetch all geocaches matching the filters.

Parameters

[in]

array

$params

An optional associative array of options for filtering/limit.

limit (integer): Max number of rows to return (default=100, max=1000)
dontCountArchivedTowardsLimit: (bool) defaults to true
dontCountDisabledTowardsLimit: (bool) defaults to false
alternativeDBCluster: (bool) defaults to false - Generally faster if processing lots of data, like multiple countries.
filter (array): An associative array with filters
- country (string or array)
- region (string or array)
- county (string or array)
- types (array): An array of valid types
- sizes (array): An array of valid sizes
- difficulties (array): An array of valid values
- terrains (array): An array of valid values
- excludeOwner (int): Exclude geocaches by this ownerId
- excludeDisabled (bool): Exclude disabled geocaches, defaults to false
- excludeArchived (bool): Exclude archived geocaches, defaults to false
- requiredFP (int): Required favorite points.
- minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date.

Returns: An associative array with the data.

◆ GetIso3166_1alpha2Table()

static PGC_LUA_Sandbox::GetIso3166_1alpha2Table ( $flip = false )

static

Returns an associative array with country-abbreviation as key and country name as value (or the opposite if flip is used)

Parameters

[in] bool $flip True to flip the array and use names as keys.

◆ GetJsonData()

static PGC_LUA_Sandbox::GetJsonData ( $lookupKey )

static

Get a json blob from the PGC servers.

This function is a bit special. If you have larger data-sets, you can ask support to have it stored on the Project-GC servers, and then retrieve it like this. This is to avoid having several kilobytes or megabytes of data inside the LUA scripts.

Parameters

[in] string $lookupKey A lookup string for the json data you want returned.

Returns: The json data decoded into an array.

◆ GetLabCacheFinds()

static PGC_LUA_Sandbox::GetLabCacheFinds ( $profileId )

static

Returns an associative array with the labcache finds from given profileId.

Returned fields: guid, name, date_found

Parameters

[in] int $profileId An integer with the users profile id.

◆ GetLonelyFinds()

static PGC_LUA_Sandbox::GetLonelyFinds	(	$profileId,
		$days,
		$params = `[]`
	)

static

Returns an associative array with finds on geocaches that haven't been found in $days days before the Geocacher found it.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	int	$days	An integer with the minimum number of days required.
[in]	array	$params	An optional associative array of options. limit (integer): Max number of rows to return fallback (string): Either 'last_publish_date' or 'hidden', or not set. If set, will use the alternative field if the geocache haven't been found before. Returned fields: gccode, visitdate, former_visitdate, num_days Automatically sorts on num_days descending To get additional related find data, use the GetFinds method and merge them together.

◆ GetLowestCaches()

static PGC_LUA_Sandbox::GetLowestCaches ( $params = [] )

static

Retuns an associative array with cache data for the lowest elevation geocaches according to the filter. Based on Project-GC's elevation data.

Can return more than limit rows. Will first figure out the highest elevation allowed, and then fetch all geocaches matching the filters.

Parameters

[in]

array

$params

An optional associative array of options for filtering/limit.

limit (integer): Max number of rows to return (default=100, max=1000)
dontCountArchivedTowardsLimit: (bool) defaults to true
dontCountDisabledTowardsLimit: (bool) defaults to false
alternativeDBCluster: (bool) defaults to false - Generally faster if processing lots of data, like multiple countries.
filter (array): An associative array with filters
- country (string or array)
- region (string or array)
- county (string or array)
- types (array): An array of valid types
- sizes (array): An array of valid sizes
- difficulties (array): An array of valid values
- terrains (array): An array of valid values
- excludeOwner (int): Exclude geocaches by this ownerId
- excludeDisabled (bool): Exclude disabled geocaches, defaults to false
- excludeArchived (bool): Exclude archived geocaches, defaults to false
- requiredFP (int): Required favorite points.
- minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date.

Returns: An associative array with the data.

◆ GetMembershipCreatedDate()

static PGC_LUA_Sandbox::GetMembershipCreatedDate ( $profileId )

static

Gets the date the user registered at Geocaching.com.

Parameters

[in] int $profileId An integer with the users profile id.

Returns: A string with a date in ISO format, can also return FALSE if the date is unknown

◆ GetNumberOfCountiesInCountry()

static PGC_LUA_Sandbox::GetNumberOfCountiesInCountry ( $country )

static

Returns number of counties in a country.

The number returned is based on Project-GC's polygon data. If no such data exists, a FALSE will be returned.

Parameters

[in] string country

◆ GetNumberOfCountiesInRegion()

static PGC_LUA_Sandbox::GetNumberOfCountiesInRegion	(	$country,
		$region
	)

static

Returns number of counties in a region.

The number returned is based on Project-GC's polygon data. If no such data exists, a FALSE will be returned.

Parameters

[in]	string	country
[in]	string	region

◆ GetNumberOfRegionsInCountry()

static PGC_LUA_Sandbox::GetNumberOfRegionsInCountry ( $country )

static

Returns number of regions in a country.

The number returned is based on Project-GC's polygon data. If no such data exists, a FALSE will be returned.

Parameters

[in] string country

◆ GetNumCachesInArea()

static PGC_LUA_Sandbox::GetNumCachesInArea ( $params )

static

Gets the number of geocaches in a defined area.

Parameters

[in]

array

$params

An optional associative array of options for filtering.

filter (array): An associative array with filters
- country (string or array) Required
- region (string or array)
- county (string or array) Note that some countries has several counties with the same name. It's best practice to include the region name as well.
- types (array): An array of valid types
- sizes (array): An array of valid sizes
- difficulties (array): An array of valid values
- terrains (array): An array of valid values
- excludeDisabled (bool): Exclude disabled geocaches, defaults to false
- excludeArchived (bool): Exclude archived geocaches, defaults to false
- excludeOwner (int): Exclude geocaches by this ownerId
- minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date
- maxHiddenDate (string): YYYY-MM-DD, the date will be included, ie: <= date

Returns: An integer with number of geocaches

◆ GetNumTrackablesDiscovered()

static PGC_LUA_Sandbox::GetNumTrackablesDiscovered ( $profileId )

static

Get number of discovered trackables.

Parameters

[in] int $profileId An integer with the users profile id.

Returns: An associative array (trackablesDiscovered, travelbugsDiscovered, coinsDiscovered) where travel bugs are defined by BadgeGen's rules.

◆ GetOldestCaches()

static PGC_LUA_Sandbox::GetOldestCaches ( $params = [] )

static

Retuns an associative array with cache data for the oldest geocaches according to the filter. Based on hidden date.

Can return more than limit rows. Will first figure out the newest hidden date allowed, and then fetch all geocaches matching the filters before that date.

Parameters

[in]

array

$params

An optional associative array of options for filtering/limit.

limit (integer): Max number of rows to return (default=100, max=1000)
dontCountArchivedTowardsLimit: (bool) defaults to true
dontCountDisabledTowardsLimit: (bool) defaults to false
alternativeDBCluster: (bool) defaults to false - Generally faster if processing lots of data, like multiple countries.
filter (array): An associative array with filters
- country (string or array)
- region (string or array)
- county (string or array)
- types (array): An array of valid types
- sizes (array): An array of valid sizes
- difficulties (array): An array of valid values
- terrains (array): An array of valid values
- excludeOwner (int): Exclude geocaches by this ownerId
- excludeDisabled (bool): Exclude disabled geocaches, defaults to false
- excludeArchived (bool): Exclude archived geocaches, defaults to false
- requiredFP (int): Required favorite points.
- minHiddenDate (string): YYYY-MM-DD, the date will be included, ie: >= date. Defaults to 2000-05-03. Can be set to 1970-01-01 to include everything.

Returns: An associative array with the data.

◆ GetPGCGeoJson()

static PGC_LUA_Sandbox::GetPGCGeoJson	(	$level,
		$country,
		$regionNames = `[]`,
		$countyNames = `[]`,
		$landonly = `false`
	)

static

Returns a list of GeoJSONs in string format.

Parameters

[in]	int	$level	One of: country, region, county. Has no default.
[in]	int	$country	A string representing the country.
[in]	array	$regionNames	A list of region names to filter on. Can be left empty/unset. Ignored if level is 'country'.
[in]	array	$countyNames	A list of county names to filter on. Can be left empty/unset. Ignored if level is 'country' or 'region'.
[in]	bool	$landOnly	Returns polygons clipped to coastline if true. These generally are more expensive to use, don't overlay all of the geocaches, but look better/more correct.

Returns: list of { name: string, geojson: string }

◆ GetPublishers()

static PGC_LUA_Sandbox::GetPublishers	(	$profileId,
		$params = `array()`
	)

static

Retuns an associative array with cache_id, gccode, publisher_id, publisher_name, publish_date, visitdate, log_id for each find.

Note that a cache can be published multiple times and will then be returned once for each publisher (or twice if it was the same publisher). One should also be aware of that "Publish listing" is a log type that haven't always existed, not all geocaches has a publisher.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional array of options for filtering. type: Can be set to finds or hides, defaults to finds. Will make this method get the publishers for either the users finds, or hides. Some filters (visitdate) will not work together with types=hides, and may result in errors or unexpected results. order: NEWESTFIRST to sort with the newest publishes first, or OLDESTFIRST for the opposite filter (array): An associative array with filters (implementation not tested) country: Only geocaches located in this country region: Only geocaches located in this region county: Only geocaches located in this county minVisitDate (YYYY-MM-DD): Minimum visit date (inclusive) maxVisitDate (YYYY-MM-DD): Maximum visit date (inclusive)

Returns: An associative array with the data.

◆ GetRegionNamesInCountry()

static PGC_LUA_Sandbox::GetRegionNamesInCountry ( $country )

static

Returns a list of region names given a country.

Parameters

[in] string country

◆ GetRegionPolygonInfoFromCountry()

static PGC_LUA_Sandbox::GetRegionPolygonInfoFromCountry ( $country )

static

Parameters

[in] string country

◆ GetSouvenirs()

static PGC_LUA_Sandbox::GetSouvenirs	(	$profileId,
		$params = `array()`
	)

static

Retuns an associative array with date_discovered, souvenir_guid, image_path, thumb_path, title, pgc_group for each souvenir.

Parameters

[in]	int	$profileId	An integer with the users profile id.
[in]	array	$params	An optional associative array of options for filtering/sorting/limit. order: NEWESTFIRST to sort with the newest finds first, or OLDESTFIRST for the opposite

Returns: An associative array with the data.

◆ HTMLEscape()

static PGC_LUA_Sandbox::HTMLEscape ( $string )

static

Returns an HTML escaped string.

This should be used on all data contributed from users that will be outputed as HTML. Including data from Geocaching.com, for example cache names.

Parameters

[in] array $string A string that should be escaped.

Returns: An escaped string.

◆ Log()

static PGC_LUA_Sandbox::Log ( )

static

Log a string that can be retrieved if the script timeouts.

Max amount of log per checker run is 100 kB. The log entries will be available for 1 hour. Normally all in-parameters are concatenated to a single string. New-line isn't added automatically. But! If the first argument is an array, that argument, and only that argument, will be converted to a readable blob The log output can be retrieved at https://project-gc.com/Tools/Challenges?viewDebugLog=token, where token is the token you get when running the script.

◆ print()

static PGC_LUA_Sandbox::print ( )

static

Prints output into the Debug output window.

This function can handle multiple arguments. Each argument can be either a string or a list. In case of lists it will output a formatted dump.

◆ ProfileId2Name()

static PGC_LUA_Sandbox::ProfileId2Name ( $profileId )

static

Returns the Profile name of a user from given Profile ID.

Parameters

[in] integer $profileId The Profile ID to convert to a Profile name.

Returns: Profile Name as a string. Can also return FALSE in case the name is unknown (GDPR optout for example)

◆ ProfileName2Id()

static PGC_LUA_Sandbox::ProfileName2Id ( $profileName )

static

Returns the Profile ID of a user from given Profile name.

Parameters

[in] string $profileName The Profile name to convert to an ID.

Returns: Profile ID as an integer.

◆ UTF8StrLen()

static PGC_LUA_Sandbox::UTF8StrLen ( $string )

static

Returns length of string.

Implemented since LUA doesn't have unicode support in their functions (for example string.len).

Parameters

[in] string $string The UTF-8 string to extract from.

Returns: Number of characters.

◆ UTF8SubStr()

static PGC_LUA_Sandbox::UTF8SubStr	(	$string,
		$start,
		$length
	)

static

Gets a part of a string.

Implemented since LUA doesn't have unicode support in their functions (for example string.substr).

Parameters

[in]	string	$string	The UTF-8 string to extract from.
[in]	int	$start	Position of the first character to use. 1-based (first character is number 1).
[in]	int	$length	Maximum number of characters to use from string.

Returns: An uppercase UTF-8 string.

◆ UTF8ToLower()

static PGC_LUA_Sandbox::UTF8ToLower ( $string )

static

Converts string to lower case.

Implemented since LUA doesn't have unicode support in their functions (for example string.lower).

Parameters

[in] string $string The UTF-8 string to convert to lower case.

Returns: An uppercase UTF-8 string.

◆ UTF8ToUpper()

static PGC_LUA_Sandbox::UTF8ToUpper ( $string )

static

Converts string to upper case.

Implemented since LUA doesn't have unicode support in their functions (for example string.upper).

Parameters

[in] string $string The UTF-8 string to convert to upper case.

Returns: An uppercase UTF-8 string.

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ CreateHTMLTable()

◆ DistanceHaversine()

◆ DistanceVincenty()

◆ Gccode2CacheName()

◆ GetAttributeList()

◆ GetBadgeGenDataV3()

◆ GetBadgeGenDataV4()

◆ GetBookmarklist()

◆ GetContinentDefinitions()

◆ GetCountryPolygonInfo()

◆ GetCountyNamesInCountry()

◆ GetCountyNamesInRegion()

◆ GetCountyPolygonInfoFromCountry()

◆ GetCountyPolygonInfoFromRegion()

◆ GetCPUUsage()

◆ GetFavorites()

◆ GetFinds()

◆ GetFPDetailsForUser()

◆ GetFurthestFound()

◆ GetHides()

◆ GetHighestCaches()

◆ GetIso3166_1alpha2Table()

◆ GetJsonData()

◆ GetLabCacheFinds()

◆ GetLonelyFinds()

◆ GetLowestCaches()

◆ GetMembershipCreatedDate()

◆ GetNumberOfCountiesInCountry()

◆ GetNumberOfCountiesInRegion()

◆ GetNumberOfRegionsInCountry()

◆ GetNumCachesInArea()

◆ GetNumTrackablesDiscovered()

◆ GetOldestCaches()

◆ GetPGCGeoJson()

◆ GetPublishers()

◆ GetRegionNamesInCountry()

◆ GetRegionPolygonInfoFromCountry()

◆ GetSouvenirs()

◆ HTMLEscape()

◆ Log()

◆ print()

◆ ProfileId2Name()

◆ ProfileName2Id()

◆ UTF8StrLen()

◆ UTF8SubStr()

◆ UTF8ToLower()

◆ UTF8ToUpper()