Embed

Google API object class for the Joomla Framework.

abstract deprecated
since

1.0

deprecated

The joomla/google package is deprecated

Methods

__construct

Constructor.

__construct(array $options = array(), \Joomla\Uri\Uri $uri = null) 
since

1.0

Arguments

$options

arrayGoogle options object

$uri

\Joomla\Uri\UriURL of the page being rendered

echoBody

Method to output the body for the API

echoBody() : void
since

1.0

echoHeader

Method to output the javascript header for the embed API

echoHeader() : void
since

1.0

getBody

Method to retrieve the body for the API

getBody() : string
abstract
since

1.0

Response

stringThe body

getHeader

Method to retrieve the header for the API

getHeader() : string
abstract
since

1.0

Response

stringThe header

getOption

Get an option from the Embed instance.

getOption(string $key) : mixed
since

1.0

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

isSecure

Method to retrieve the javascript header for the embed API

isSecure() : string
since

1.0

Response

stringThe header

setOption

Set an option for the Embed instance.

setOption(string $key, mixed $value) : \Joomla\Google\Embed
since

1.0

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\Joomla\Google\EmbedThis object for method chaining.

Properties

options

Options for the Google data object.

since

1.0

Type(s)

array

uri

URI of the page being rendered.

since

1.0

Type(s)

\Joomla\Uri\Uri