\web\lib\adminMapGoogle

This class provides map display functionality

Summary

Methods
Properties
Constants
instance()
htmlHeadCode()
htmlBodyCode()
bodyTagCode()
htmlShowtime()
optionListDisplayCode()
__construct()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

instance()

instance(\core\IdP  inst,   readonly) : \web\lib\admin\MapNone|\web\lib\admin\MapOpenLayers|\web\lib\admin\MapGoogle

loads the configured map type

Parameters

\core\IdP inst
readonly

Throws

\web\lib\admin\Exception

Returns

\web\lib\admin\MapNone|\web\lib\admin\MapOpenLayers|\web\lib\admin\MapGoogle —

htmlHeadCode()

htmlHeadCode() : 

If the map needs to inject code into <head>, it is generated in this function.

Returns

htmlBodyCode()

htmlBodyCode() : 

If the map needs to inject code into <body> to enable a map (like JavaScript code), it is generated in this function. The actual HTML is defined in the htmlShowtime() function below.

Returns

bodyTagCode()

bodyTagCode() : 

If the map needs to modify the <body> tag itself (e.g. an onLoad() function), it is generated in this function

Returns

htmlShowtime()

htmlShowtime( wizard = FALSE,  additional = FALSE) : 

Code to display the map and surrounding HTML to display the map. Providers probably will want to return different pieces of code depending on whether we're $this->readOnly or not.

For edit mode, the option parser (after hitting Submit) expects a coordinate pair in the HTML parameters 'geo_lat' and 'geo_long'. The code in this function should fill these parameters. The parameters themselves are generated if making use of the htmlPostEdit() function, or can of course be written by this htmlShowtime function itself.

Parameters

wizard
additional

Returns

optionListDisplayCode()

optionListDisplayCode( coords,  number) : 

How are coordinates displayed in the enumeration of inst options? This function provides the HTML for that.

The parameter is the JSON representation of a coordinate pair.

Parameters

coords
number

Returns

__construct()

__construct( inst,  readonly) : 

Parameters

inst
readonly

Returns