Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JGoogleEmbedMaps
+ Graphe d'héritage de JGoogleEmbedMaps:

Fonctions membres publiques

 __construct (Registry $options=null, JUri $uri=null, JHttp $http=null)
 
 getKey ()
 
 setKey ($key)
 
 getMapId ()
 
 setMapId ($id)
 
 getMapClass ()
 
 setMapClass ($class)
 
 getMapStyle ()
 
 setMapStyle ($style)
 
 getMapType ()
 
 setMapType ($type)
 
 getAdditionalMapOptions ()
 
 setAdditionalMapOptions ($options)
 
 getAdditionalJavascript ()
 
 setAdditionalJavascript ($script)
 
 getZoom ()
 
 setZoom ($zoom)
 
 getCenter ()
 
 setCenter ($location, $title=true, $markeroptions=array(), $markerevents=array())
 
 addEventHandler ($type, $function)
 
 deleteEventHandler ($type=null)
 
 listEventHandlers ()
 
 addMarker ($location, $title=null, $options=array(), $events=array())
 
 listMarkers ()
 
 deleteMarker ($index=null)
 
 isAsync ()
 
 useAsync ()
 
 useSync ()
 
 getAsyncCallback ()
 
 setAsyncCallback ($callback)
 
 hasSensor ()
 
 useSensor ()
 
 noSensor ()
 
 getAutoload ()
 
 setAutoload ($type='onload')
 
 getHeader ()
 
 getBody ()
 
 geocodeAddress ($address)
 
- Fonctions membres publiques hérités de JGoogleEmbed
 __construct (Registry $options=null, JUri $uri=null)
 
 isSecure ()
 
 getHeader ()
 
 getBody ()
 
 echoHeader ()
 
 echoBody ()
 
 getOption ($key)
 
 setOption ($key, $value)
 

Attributs protégés

 $http
 
- Attributs protégés hérités de JGoogleEmbed
 $options
 
 $uri
 

Description détaillée

Google Maps embed class for the Joomla Platform.

Depuis
12.3
Obsolète:
4.0 Use the joomla/google package via Composer instead

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JUri  $uri = null,
JHttp  $http = null 
)

Constructor.

Paramètres
Registry$optionsGoogle options object
JUri$uriURL of the page being rendered
JHttp$httpHttp client for geocoding requests
Depuis
12.3

Références $options, et $uri.

Documentation des fonctions membres

◆ addEventHandler()

addEventHandler (   $type,
  $function 
)

Références $function, et $type.

◆ addMarker()

addMarker (   $location,
  $title = null,
  $options = array(),
  $events = array() 
)

Références $location, $options, $title, et elseif.

◆ deleteEventHandler()

deleteEventHandler (   $type = null)

Références $type, et null.

◆ deleteMarker()

deleteMarker (   $index = null)

Delete a marker from the map

Paramètres
int$indexIndex of marker to delete (defaults to last added marker)
Renvoie
array The latitude/longitude of the deleted marker
Depuis
12.3

Références null.

◆ geocodeAddress()

geocodeAddress (   $address)

Method to get the location information back from an address

Paramètres
string$addressThe address to geocode
Renvoie
array An array containing Google's geocode data
Depuis
12.3

Références $data, $key, et $uri.

◆ getAdditionalJavascript()

getAdditionalJavascript ( )

Method to get additional map options

Renvoie
string The options
Depuis
12.3

◆ getAdditionalMapOptions()

getAdditionalMapOptions ( )

Method to get additional map options

Renvoie
string The options
Depuis
12.3

◆ getAsyncCallback()

getAsyncCallback ( )

Method to get callback function for async javascript loading

Renvoie
string The ID
Depuis
12.3

◆ getAutoload()

getAutoload ( )

Checks how the script should be loaded

Renvoie
string Autoload type (onload, jquery, mootools, or false)
Depuis
12.3

◆ getBody()

getBody ( )

Method to retrieve the div that the map is loaded into

Renvoie
string The body
Depuis
12.3

Références $class, $id, $output, et $style.

◆ getCenter()

getCenter ( )

Method to set the center of the map

Renvoie
mixed A latitude longitude array or an address string
Depuis
12.3

◆ getHeader()

getHeader ( )

Get code to load Google Maps javascript

Renvoie
string Javascript code
Depuis
12.3

Références $id, $key, $options, $output, $title, $type, et json_encode.

◆ getKey()

getKey ( )

Method to get the API key

Renvoie
string The Google Maps API key
Depuis
12.3

◆ getMapClass()

getMapClass ( )

Method to get the class of the map div

Renvoie
string The class
Depuis
12.3

◆ getMapId()

getMapId ( )

Method to get the id of the map div

Renvoie
string The ID
Depuis
12.3

◆ getMapStyle()

getMapStyle ( )

Method to get the style of the map div

Renvoie
string The style
Depuis
12.3

◆ getMapType()

getMapType ( )

Method to get the map type setting

Renvoie
string The class
Depuis
12.3

◆ getZoom()

getZoom ( )

Method to get the zoom

Renvoie
int The zoom level
Depuis
12.3

◆ hasSensor()

hasSensor ( )

Checks if a sensor is set to be required

Renvoie
boolean True if asynchronous
Depuis
12.3

Références false, et null.

◆ isAsync()

isAsync ( )

Checks if the javascript is set to be asynchronous

Renvoie
boolean True if asynchronous
Depuis
12.3

Références null, et true.

◆ listEventHandlers()

listEventHandlers ( )

List the events added to the map

Renvoie
array A list of events
Depuis
12.3

◆ listMarkers()

listMarkers ( )

List the markers added to the map

Renvoie
array A list of markers
Depuis
12.3

◆ noSensor()

noSensor ( )

Don't require access to sensor data

Renvoie
JGoogleEmbedAMaps The object for method chaining
Depuis
12.3

◆ setAdditionalJavascript()

setAdditionalJavascript (   $script)

Method to add additional javascript

Paramètres
array$scriptAdditional javascript
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $script.

◆ setAdditionalMapOptions()

setAdditionalMapOptions (   $options)

Method to add additional map options

Paramètres
array$optionsAdditional map options
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $options.

◆ setAsyncCallback()

setAsyncCallback (   $callback)

Method to set the callback function for async javascript loading

Paramètres
string$callbackThe callback function name
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

◆ setAutoload()

setAutoload (   $type = 'onload')

Automatically add the callback to the window

Paramètres
string$typeThe method to add the callback (options are onload, jquery, mootools, and false)
Renvoie
JGoogleEmbedAMaps The object for method chaining
Depuis
12.3

Références $type.

◆ setCenter()

setCenter (   $location,
  $title = true,
  $markeroptions = array(),
  $markerevents = array() 
)

Références $location, $title, elseif, et null.

◆ setKey()

setKey (   $key)

Method to set the API key

Paramètres
string$keyThe Google Maps API key
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $key.

◆ setMapClass()

setMapClass (   $class)

Method to set the map div class

Paramètres
string$classThe class
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $class.

◆ setMapId()

setMapId (   $id)

Method to set the map div id

Paramètres
string$idThe ID
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $id.

◆ setMapStyle()

setMapStyle (   $style)

Method to set the map div style

Paramètres
string$styleThe style
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $style.

◆ setMapType()

setMapType (   $type)

Method to set the map type ()

Paramètres
string$typeValid types are ROADMAP, SATELLITE, HYBRID, and TERRAIN
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

Références $type.

◆ setZoom()

setZoom (   $zoom)

Method to set the map zoom

Paramètres
int$zoomZoom level (0 is whole world)
Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

◆ useAsync()

useAsync ( )

Load javascript asynchronously

Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

◆ useSensor()

useSensor ( )

Require access to sensor data

Renvoie
JGoogleEmbedMaps The object for method chaining
Depuis
12.3

◆ useSync()

useSync ( )

Load javascript synchronously

Renvoie
JGoogleEmbedAMaps The object for method chaining
Depuis
12.3

Documentation des champs

◆ $http

$http
protected

La documentation de cette classe a été générée à partir du fichier suivant :