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

Fonctions membres publiques

 getCode ()
 
 setCode ($code)
 
 isAsync ()
 
 useAsync ()
 
 useSync ()
 
 addCall ($method, $params=array())
 
 listCalls ()
 
 deleteCall ($index=null)
 
 createCall ($method, $params=array())
 
 addCustomVar ($slot, $name, $value, $scope=3)
 
 createCustomVar ($slot, $name, $value, $scope=3)
 
 addEvent ($category, $action, $label=null, $value=null, $noninteract=false)
 
 createEvent ($category, $action, $label=null, $value=null, $noninteract=false)
 
 getHeader ()
 
 getBody ()
 
- 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)
 

Membres hérités additionnels

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

Description détaillée

Google Analytics embed class for the Joomla Platform.

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

Documentation des fonctions membres

◆ addCall()

addCall (   $method,
  $params = array() 
)

Add an analytics call

Paramètres
string$methodThe name of the function
array$paramsThe parameters for the call
Renvoie
array The added call
Depuis
3.1.4

Références $params.

◆ addCustomVar()

addCustomVar (   $slot,
  $name,
  $value,
  $scope = 3 
)

Add a custom variable to the analytics

Paramètres
int$slotThe slot to store the variable in (1-5)
string$nameThe variable name
string$valueThe variable value
int$scopeThe scope of the variable (1: visitor level, 2: session level, 3: page level)
Renvoie
array The added call
Depuis
3.1.4

Références $name, et $value.

◆ addEvent()

addEvent (   $category,
  $action,
  $label = null,
  $value = null,
  $noninteract = false 
)

Track an analytics event

Paramètres
string$categoryThe general event category
string$actionThe event action
string$labelThe event description
string$valueThe value of the event
boolean$noninteractDon't allow this event to impact bounce statistics
Renvoie
array The added call
Depuis
3.1.4

Références $action, $category, $label, et $value.

◆ createCall()

createCall (   $method,
  $params = array() 
)

Create a javascript function from the call parameters

Paramètres
string$methodThe name of the function
array$paramsThe parameters for the call
Renvoie
string The created call
Depuis
3.1.4

Références $output, $params, et json_encode.

◆ createCustomVar()

createCustomVar (   $slot,
  $name,
  $value,
  $scope = 3 
)

Get the code to create a custom analytics variable

Paramètres
int$slotThe slot to store the variable in (1-5)
string$nameThe variable name
string$valueThe variable value
int$scopeThe scope of the variable (1: visitor level, 2: session level, 3: page level)
Renvoie
string The created call
Depuis
3.1.4

Références $name, et $value.

◆ createEvent()

createEvent (   $category,
  $action,
  $label = null,
  $value = null,
  $noninteract = false 
)

Get the code to track an analytics event

Paramètres
string$categoryThe general event category
string$actionThe event action
string$labelThe event description
string$valueThe value of the event
boolean$noninteractDon't allow this event to impact bounce statistics
Renvoie
string The created call
Depuis
3.1.4

Références $action, $category, $label, et $value.

◆ deleteCall()

deleteCall (   $index = null)

Delete a call from the stack

Paramètres
int$indexIndex of call to delete (defaults to last added call)
Renvoie
array The deleted call
Depuis
3.1.4

Références null.

◆ getBody()

getBody ( )

Google Analytics only needs to be included in the header

Renvoie
null
Depuis
3.1.4

Références $output, et $prefix.

◆ getCode()

getCode ( )

Method to get the tracking code

Renvoie
string The Google Analytics tracking code
Depuis
3.1.4

◆ getHeader()

getHeader ( )

Get code to load Google Analytics javascript

Renvoie
string Javascript code
Depuis
3.1.4

Références $output.

◆ isAsync()

isAsync ( )

Checks if the javascript is set to be asynchronous

Renvoie
boolean True if asynchronous
Depuis
3.1.4

Références null, et true.

◆ listCalls()

listCalls ( )

List the analytics calls to be executed

Renvoie
array A list of calls
Depuis
3.1.4

◆ setCode()

setCode (   $code)

Method to set the tracking code

Paramètres
string$codeThe Google Analytics tracking code
Renvoie
JGoogleEmbedAnalytics The object for method chaining
Depuis
3.1.4

◆ useAsync()

useAsync ( )

Load javascript asynchronously

Renvoie
JGoogleEmbedAnalytics The object for method chaining
Depuis
3.1.4

◆ useSync()

useSync ( )

Load javascript synchronously

Renvoie
JGoogleEmbedAnalytics The object for method chaining
Depuis
3.1.4

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