Joomla! API

Google API object class for the Joomla Platform.

abstract deprecated

since	3.1.4
deprecated	4.0 Use the `joomla/google` package via Composer instead
package	Joomla.Platform

Methods

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JUri $uri = null)

since	3.1.4

Arguments

$options: \Joomla\Registry\RegistryGoogle options object
$uri: \JUriURL of the page being rendered

Method to output the body for the API

echoBody() : null

since	3.1.4

Response

null

Method to output the javascript header for the embed API

echoHeader() : null

since	3.1.4

Response

null

Method to retrieve the body for the API

getBody() : string

abstract

since	3.1.4

Response

stringThe body

Method to retrieve the header for the API

getHeader() : string

abstract

since	3.1.4

Response

stringThe header

Get an option from the JGoogleEmbed instance.

getOption(string $key) : mixed

since	3.1.4

Arguments

$key: stringThe name of the option to get.

Response

mixedThe option value.

Method to retrieve the javascript header for the embed API

isSecure() : string

since	3.1.4

Response

stringThe header

Set an option for the JGoogleEmbed instance.

setOption(string $key, mixed $value) : \JGoogleEmbed

since	3.1.4

Arguments

$key: stringThe name of the option to set.
$value: mixedThe option value to set.

Response

\JGoogleEmbedThis object for method chaining.

Properties

Options for the Google data object.

since	3.1.4

Type(s)

\Joomla\Registry\Registry

URI of the page being rendered.

since	3.1.4

Type(s)

\JUri