Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGoogleEmbed
+ Graphe d'héritage de JGoogleEmbed:

Liste de tous les membres

Fonctions membres publiques

 __construct (JRegistry $options=null, JUri $uri=null)
 isSecure ()
 getHeader ()
 getBody ()
 echoHeader ()
 echoBody ()
 getOption ($key)
 setOption ($key, $value)

Attributs protégés

 $options
 $uri

Description détaillée

Définition à la ligne 20 du fichier embed.php.


Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:
JRegistry$optionsGoogle options object
JUri$uriURL of the page being rendered
Depuis:
12.3

Définition à la ligne 42 du fichier embed.php.

{
$this->options = $options ? $options : new JRegistry;
$this->uri = $uri ? $uri : new JUri;
}

Documentation des fonctions membres

JGoogleEmbed::echoBody ( )

Method to output the body for the API

Renvoie:
null
Depuis:
12.3

Définition à la ligne 97 du fichier embed.php.

{
echo $this->getBody();
}
JGoogleEmbed::echoHeader ( )

Method to output the javascript header for the embed API

Renvoie:
null
Depuis:
12.3

Définition à la ligne 85 du fichier embed.php.

{
echo $this->getHeader();
}
JGoogleEmbed::getBody ( )
abstract

Method to retrieve the body for the API

Renvoie:
string The body
Depuis:
12.3

Réimplémentée dans JGoogleEmbedMaps, et JGoogleEmbedAnalytics.

JGoogleEmbed::getHeader ( )
abstract

Method to retrieve the header for the API

Renvoie:
string The header
Depuis:
12.3

Réimplémentée dans JGoogleEmbedMaps, et JGoogleEmbedAnalytics.

JGoogleEmbed::getOption (   $key)

Get an option from the JGoogleEmbed instance.

Paramètres:
string$keyThe name of the option to get.
Renvoie:
mixed The option value.
Depuis:
12.3

Définition à la ligne 111 du fichier embed.php.

{
return $this->options->get($key);
}
JGoogleEmbed::isSecure ( )

Method to retrieve the javascript header for the embed API

Renvoie:
string The header
Depuis:
12.3

Définition à la ligne 55 du fichier embed.php.

Références JUri\getScheme().

{
return $this->uri->getScheme() == 'https';
}

+ Voici le graphe d'appel pour cette fonction :

JGoogleEmbed::setOption (   $key,
  $value 
)

Set an option for the JGoogleEmbed instance.

Paramètres:
string$keyThe name of the option to set.
mixed$valueThe option value to set.
Renvoie:
JGoogleEmbed This object for method chaining.
Depuis:
12.3

Définition à la ligne 126 du fichier embed.php.

{
$this->options->set($key, $value);
return $this;
}

Documentation des données membres

JGoogleEmbed::$options
protected

Définition à la ligne 26 du fichier embed.php.

JGoogleEmbed::$uri
protected

Définition à la ligne 32 du fichier embed.php.


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