Docs For Class JGoogleEmbed

Description

Google API object class for the Joomla Platform.

abstract:
since: 12.3

Located in /libraries/joomla/google/embed.php (line 20)

Direct descendents

Class	Description
JGoogleEmbedAnalytics	Google Analytics embed class for the Joomla Platform.
JGoogleEmbedMaps	Google Maps embed class for the Joomla Platform.

Variable Summary

JRegistry $options

JUri $uri

Method Summary

JGoogleEmbed __construct ([JRegistry $options = null], [JUri $uri = null])

null echoBody ()

null echoHeader ()

string getBody ()

string getHeader ()

mixed getOption (string $key)

string isSecure ()

JGoogleEmbed setOption (string $key, mixed $value)

Variables

JRegistry $options (line 26)

var: Options for the Google data object.
since: 12.3
access: protected

JUri $uri (line 32)

var: URI of the page being rendered.
since: 12.3
access: protected

Methods

Constructor __construct (line 42)

Constructor.

since: 12.3
access: public

JGoogleEmbed __construct ([JRegistry $options = null], [JUri $uri = null])

JRegistry $options: Google options object
JUri $uri: URL of the page being rendered

Redefined in descendants as:

JGoogleEmbedMaps::__construct() : Constructor.

echoBody (line 97)

Method to output the body for the API

since: 12.3
access: public

null echoBody ()

echoHeader (line 85)

Method to output the javascript header for the embed API

since: 12.3
access: public

null echoHeader ()

getBody (line 76)

Method to retrieve the body for the API

return: The body
abstract:
since: 12.3
access: public

string getBody ()

Redefined in descendants as:

JGoogleEmbedAnalytics::getBody() : Google Analytics only needs to be included in the header
JGoogleEmbedMaps::getBody() : Method to retrieve the div that the map is loaded into

getHeader (line 67)

Method to retrieve the header for the API

return: The header
abstract:
since: 12.3
access: public

string getHeader ()

Redefined in descendants as:

JGoogleEmbedAnalytics::getHeader() : Get code to load Google Analytics javascript
JGoogleEmbedMaps::getHeader() : Get code to load Google Maps javascript

getOption (line 111)

Get an option from the JGoogleEmbed instance.

return: The option value.
since: 12.3
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

isSecure (line 55)

Method to retrieve the javascript header for the embed API

return: The header
since: 12.3
access: public

string isSecure ()

setOption (line 126)

Set an option for the JGoogleEmbed instance.

return: This object for method chaining.
since: 12.3
access: public

JGoogleEmbed setOption (string $key, mixed $value)

string $key: The name of the option to set.
mixed $value: The option value to set.