MapsGoogleMapsUtils Class Reference

List of all members.

Public Member Functions
	createTypesString (array &$types, $enableEarth)
	Returns a JS items string with the provided types.
Static Public Member Functions
static	getGMapType ($type, $restoreAsDefault=false)
	Returns the Google Map type (defined in MapsGoogleMaps::$mapTypes) for the provided a general map type.
static	createControlsString (array $controls)
	Build up a csv string with the controls, to be outputted as a JS array.
static	getDefaultParams ()
	Retuns an array holding the default parameters and their values.
static	addGMapDependencies (&$output)
	Add references to the Google Maps API and required JS file to the provided output.
static	getAutozoomJSValue ($autozoom)
	Retuns a boolean as string, true if $autozoom is on or yes.
static	getEarthValue ($earthValue, $adaptDefault=true)
	Returns a boolean representing if the earth map type should be showed or not, when provided the the wiki code value.
Static Private Attributes
static	$mapTypes
static	$controlClasses

---

Detailed Description

Definition at line 16 of file Maps_GoogleMapsUtils.php.

---

Member Function Documentation

static MapsGoogleMapsUtils::getGMapType	(	$	type,
		$	restoreAsDefault = false
	)			[static]

Returns the Google Map type (defined in MapsGoogleMaps::$mapTypes) for the provided a general map type.

When no match is found, false will be returned.

Parameters:

	string	$type
	boolean	$restoreAsDefault

Returns:

string or false

Definition at line 70 of file Maps_GoogleMapsUtils.php.

References $egMapsGoogleMapsType.

Referenced by MapsGoogleMaps::addSpecificMapHTML().

static MapsGoogleMapsUtils::createControlsString

(

array $

controls

)

[static]

Build up a csv string with the controls, to be outputted as a JS array.

Parameters:

array

$controls

Returns:

csv string

Definition at line 93 of file Maps_GoogleMapsUtils.php.

References $egMapsGMapControls, and MapsMapper::createJSItemsString().

Referenced by MapsGoogleMaps::addSpecificMapHTML().

static MapsGoogleMapsUtils::getDefaultParams

(

)

[static]

Retuns an array holding the default parameters and their values.

Returns:

array

Definition at line 103 of file Maps_GoogleMapsUtils.php.

References $egMapsGoogleAutozoom.

Referenced by MapsGoogleMaps::setMapSettings().

static MapsGoogleMapsUtils::addGMapDependencies

(

&$

output

)

[static]

Add references to the Google Maps API and required JS file to the provided output.

Parameters:

unknown_type

$output

Definition at line 121 of file Maps_GoogleMapsUtils.php.

References $egMapsIncludePath.

Referenced by MapsGoogleMaps::doMapServiceLoad(), and MapsOpenLayersUtils::loadDependencyWhenNeeded().

static MapsGoogleMapsUtils::getAutozoomJSValue

(

$

autozoom

)

[static]

Retuns a boolean as string, true if $autozoom is on or yes.

Parameters:

string

$autozoom

Returns:

string

Definition at line 139 of file Maps_GoogleMapsUtils.php.

References MapsMapper::getJSBoolValue().

Referenced by MapsGoogleMaps::addSpecificMapHTML().

static MapsGoogleMapsUtils::getEarthValue	(	$	earthValue,
		$	adaptDefault = true
	)			[static]

Returns a boolean representing if the earth map type should be showed or not, when provided the the wiki code value.

Parameters:

	string	$earthValue
	boolean	$adaptDefault When not set to false, the default map type will be changed to earth when earth is enabled

Returns:

boolean Indicates wether the earth type should be enabled.

Definition at line 151 of file Maps_GoogleMapsUtils.php.

References $egMapsGoogleMapsType.

Referenced by MapsGoogleMaps::addSpecificMapHTML().

MapsGoogleMapsUtils::createTypesString	(	array &$	types,
		$	enableEarth
	)

Returns a JS items string with the provided types.

The earth type will be added to it when it's not present and $enableEarth is true. If there are no types, the default will be used.

Parameters:

	array	$types
	boolean	$enableEarth

Returns:

string

Definition at line 172 of file Maps_GoogleMapsUtils.php.

References $egMapsGoogleMapsTypes, MapsMapper::createJSItemsString(), and MapsMapper::getValidTypes().

Referenced by MapsGoogleMaps::addSpecificMapHTML().

---

Member Data Documentation

MapsGoogleMapsUtils::$mapTypes [static, private]

Definition at line 20 of file Maps_GoogleMapsUtils.php.

MapsGoogleMapsUtils::$controlClasses [static, private]

Initial value:

 array(
                                        'large' => 'GLargeMapControl3D',
                                        'small' => 'GSmallZoomControl3D',
                                        )

Definition at line 56 of file Maps_GoogleMapsUtils.php.

---

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

• Maps/GoogleMaps/Maps_GoogleMapsUtils.php