Class JGoogleEmbedAnalytics

Google Analytics embed class for the Joomla Platform.

JGoogleEmbed

JGoogleEmbedAnalytics

Package: Joomla\Platform\Google
Deprecated: 4.0 Use the joomla/google package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/google/embed/analytics.php

Methods summary

`public string`	# `getCode( )` Method to get the tracking code Method to get the tracking code Returns `string` - The Google Analytics tracking code Since 12.3
`public JGoogleEmbedAnalytics`	# `setCode( string $code )` Method to set the tracking code Method to set the tracking code Parameters `$code` `string` - $code The Google Analytics tracking code Returns `JGoogleEmbedAnalytics` - The object for method chaining Since 12.3
`public boolean`	# `isAsync( )` Checks if the javascript is set to be asynchronous Checks if the javascript is set to be asynchronous Returns `boolean` - True if asynchronous Since 12.3
`public JGoogleEmbedAnalytics`	# `useAsync( )` Load javascript asynchronously Load javascript asynchronously Returns `JGoogleEmbedAnalytics` - The object for method chaining Since 12.3
`public JGoogleEmbedAnalytics`	# `useSync( )` Load javascript synchronously Load javascript synchronously Returns `JGoogleEmbedAnalytics` - The object for method chaining Since 12.3
`public array`	# `addCall( string $method, array $params = array() )` Add an analytics call Add an analytics call Parameters `$method` `string` - $method The name of the function `$params` `array` - $params The parameters for the call Returns `array` - The added call Since 12.3
`public array`	# `listCalls( )` List the analytics calls to be executed List the analytics calls to be executed Returns `array` - A list of calls Since 12.3
`public array`	# `deleteCall( integer $index = null )` Delete a call from the stack Delete a call from the stack Parameters `$index` `integer` - $index Index of call to delete (defaults to last added call) Returns `array` - The deleted call Since 12.3
`public string`	# `createCall( string $method, array $params = array() )` Create a javascript function from the call parameters Create a javascript function from the call parameters Parameters `$method` `string` - $method The name of the function `$params` `array` - $params The parameters for the call Returns `string` - The created call Since 12.3
`public array`	# `addCustomVar( integer $slot, string $name, string $value, integer $scope = 3 )` Add a custom variable to the analytics Add a custom variable to the analytics Parameters `$slot` `integer` - $slot The slot to store the variable in (1-5) `$name` `string` - $name The variable name `$value` `string` - $value The variable value `$scope` `integer` - $scope The scope of the variable (1: visitor level, 2: session level, 3: page level) Returns `array` - The added call Since 12.3
`public string`	# `createCustomVar( integer $slot, string $name, string $value, integer $scope = 3 )` Get the code to create a custom analytics variable Get the code to create a custom analytics variable Parameters `$slot` `integer` - $slot The slot to store the variable in (1-5) `$name` `string` - $name The variable name `$value` `string` - $value The variable value `$scope` `integer` - $scope The scope of the variable (1: visitor level, 2: session level, 3: page level) Returns `string` - The created call Since 12.3
`public array`	# `addEvent( string $category, string $action, string $label = null, string $value = null, boolean $noninteract = false )` Track an analytics event Track an analytics event Parameters `$category` `string` - $category The general event category `$action` `string` - $action The event action `$label` `string` - $label The event description `$value` `string` - $value The value of the event `$noninteract` `boolean` - $noninteract Don't allow this event to impact bounce statistics Returns `array` - The added call Since 12.3
`public string`	# `createEvent( string $category, string $action, string $label = null, string $value = null, boolean $noninteract = false )` Get the code to track an analytics event Get the code to track an analytics event Parameters `$category` `string` - $category The general event category `$action` `string` - $action The event action `$label` `string` - $label The event description `$value` `string` - $value The value of the event `$noninteract` `boolean` - $noninteract Don't allow this event to impact bounce statistics Returns `string` - The created call Since 12.3
`public string`	# `getHeader( )` Get code to load Google Analytics javascript Get code to load Google Analytics javascript Returns `string` - Javascript code Since 12.3
`public null`	# `getBody( )` Google Analytics only needs to be included in the header Google Analytics only needs to be included in the header Returns `null` Since 12.3

Methods inherited from JGoogleEmbed

__construct(), echoBody(), echoHeader(), getOption(), isSecure(), setOption()

Magic methods summary

Properties summary

Properties inherited from JGoogleEmbed

$options, $uri

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGoogleEmbedAnalytics

Methods summary

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Methods inherited from JGoogleEmbed

Magic methods summary

Properties summary

Properties inherited from JGoogleEmbed