MapsYahooMapsUtils Class Reference

List of all members.

Public Member Functions

 createTypesString (array &$types)
 Returns a JS items string with the provided types.

Static Public Member Functions

static getYMapType ($type, $restoreAsDefault=false)
 Returns the Yahoo Map type (defined in MapsYahooMaps::$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 addYMapDependencies (&$output)
 Add references to the Yahoo! 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 Private Attributes

static $mapTypes


Detailed Description

Definition at line 16 of file Maps_YahooMapsUtils.php.


Member Function Documentation

static MapsYahooMapsUtils::getYMapType ( type,
restoreAsDefault = false 
) [static]

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

When no match is found, the first Google Map type will be returned as default.

Parameters:
string $type
boolean $restoreAsDefault
Returns:
string or false

Definition at line 39 of file Maps_YahooMapsUtils.php.

References $egMapsYahooMapsType.

Referenced by MapsYahooMaps::addSpecificMapHTML().

static MapsYahooMapsUtils::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 55 of file Maps_YahooMapsUtils.php.

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

Referenced by MapsYahooMaps::addSpecificMapHTML().

static MapsYahooMapsUtils::getDefaultParams (  )  [static]

Retuns an array holding the default parameters and their values.

Returns:
array

Definition at line 65 of file Maps_YahooMapsUtils.php.

References $egMapsYahooAutozoom.

Referenced by MapsYahooMaps::setMapSettings().

static MapsYahooMapsUtils::addYMapDependencies ( &$  output  )  [static]

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

Parameters:
string $output

Definition at line 80 of file Maps_YahooMapsUtils.php.

References $egMapsIncludePath.

Referenced by MapsYahooMaps::doMapServiceLoad().

static MapsYahooMapsUtils::getAutozoomJSValue ( autozoom  )  [static]

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

Parameters:
string $autozoom
Returns:
string

Definition at line 97 of file Maps_YahooMapsUtils.php.

References MapsMapper::getJSBoolValue().

Referenced by MapsYahooMaps::addSpecificMapHTML().

MapsYahooMapsUtils::createTypesString ( array &$  types  ) 

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 110 of file Maps_YahooMapsUtils.php.

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

Referenced by MapsYahooMaps::addSpecificMapHTML().


Member Data Documentation

MapsYahooMapsUtils::$mapTypes [static, private]

Initial value:

 array(
                                        'normal' => 'YAHOO_MAP_REG',
                                        'YAHOO_MAP_REG' => 'YAHOO_MAP_REG',
        
                                        'satellite' => 'YAHOO_MAP_SAT',
                                        'YAHOO_MAP_SAT' => 'YAHOO_MAP_SAT',
        
                                        'hybrid' => 'YAHOO_MAP_HYB',
                                        'YAHOO_MAP_HYB' => 'YAHOO_MAP_HYB'
                                        )

Definition at line 19 of file Maps_YahooMapsUtils.php.


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

Generated on Sun Mar 18 07:15:42 2012 for Semantic MediaWiki by  doxygen 1.5.6