Référence de la classe JGoogleEmbedAnalytics

Graphe d'héritage de JGoogleEmbedAnalytics:

Graphe de collaboration de JGoogleEmbedAnalytics:

Liste de tous les membres

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 inherited from JGoogleEmbed
	__construct (JRegistry $options=null, JUri $uri=null)
	isSecure ()
	echoHeader ()
	echoBody ()
	getOption ($key)
	setOption ($key, $value)

Additional Inherited Members
Attributs protégés inherited from JGoogleEmbed
	$options
	$uri

---

Description détaillée

Définition à la ligne 19 du fichier analytics.php.

---

Documentation des fonctions membres

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

Add an analytics call

Paramètres:

string	$method	The name of the function
array	$params	The parameters for the call

Renvoie:

array The added call

Depuis:

12.3

Définition à la ligne 99 du fichier analytics.php.

        {
                $call = array('name' => $method, 'params' => $params);

                $calls = $this->listCalls();
                $calls[] = $call;
                $this->setOption('calls', $calls);

                return $call;
        }

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

Add a custom variable to the analytics

Paramètres:

int	$slot	The slot to store the variable in (1-5)
string	$name	The variable name
string	$value	The variable value
int	$scope	The scope of the variable (1: visitor level, 2: session level, 3: page level)

Renvoie:

array The added call

Depuis:

12.3

Définition à la ligne 190 du fichier analytics.php.

        {
                return $this->addCall('_setCustomVar', array($slot, $name, $value, $scope));
        }

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

Track an analytics event

Paramètres:

string	$category	The general event category
string	$action	The event action
string	$label	The event description
string	$value	The value of the event
boolean	$noninteract	Don't allow this event to impact bounce statistics

Renvoie:

array The added call

Depuis:

12.3

Définition à la ligne 225 du fichier analytics.php.

        {
                return $this->addCall('_trackEvent', array($category, $action, $label, $value, $noninteract));
        }

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

Create a javascript function from the call parameters

Paramètres:

string	$method	The name of the function
array	$params	The parameters for the call

Renvoie:

string The created call

Depuis:

12.3

Définition à la ligne 158 du fichier analytics.php.

        {
                $params = array_values($params);

                if ($this->isAsync())
                {
                        $output = "_gaq.push(['{$method}',";
                        $output .= substr(json_encode($params), 1, -1);
                        $output .= ']);';
                }
                else
                {
                        $output = "pageTracker.{$method}(";
                        $output .= substr(json_encode($params), 1, -1);
                        $output .= ');';
                }

                return $output;
        }

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

Get the code to create a custom analytics variable

Paramètres:

int	$slot	The slot to store the variable in (1-5)
string	$name	The variable name
string	$value	The variable value
int	$scope	The scope of the variable (1: visitor level, 2: session level, 3: page level)

Renvoie:

string The created call

Depuis:

12.3

Définition à la ligne 207 du fichier analytics.php.

        {
                return $this->createCall('_setCustomVar', array($slot, $name, $value, $scope));
        }

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

Get the code to track an analytics event

Paramètres:

string	$category	The general event category
string	$action	The event action
string	$label	The event description
string	$value	The value of the event
boolean	$noninteract	Don't allow this event to impact bounce statistics

Renvoie:

string The created call

Depuis:

12.3

Définition à la ligne 243 du fichier analytics.php.

        {
                return $this->createCall('_trackEvent', array($category, $action, $label, $value, $noninteract));
        }

JGoogleEmbedAnalytics::deleteCall

(

$index = null

)

Delete a call from the stack

Paramètres:

int

$index

Index of call to delete (defaults to last added call)

Renvoie:

array The deleted call

Depuis:

12.3

Définition à la ligne 131 du fichier analytics.php.

        {
                $calls = $this->listCalls();

                if ($index === null)
                {
                        $index = count($calls) - 1;
                }

                $call = $calls[$index];
                unset($calls[$index]);
                $calls = array_values($calls);
                $this->setOption('calls', $calls);

                return $call;
        }

JGoogleEmbedAnalytics::getBody

(

)

Google Analytics only needs to be included in the header

Renvoie:

null

Depuis:

12.3

Réimplémentée à partir de JGoogleEmbed.

Définition à la ligne 292 du fichier analytics.php.

        {
                if (!$this->getOption('code'))
                {
                        throw new UnexpectedValueException('A Google Analytics tracking code is required.');
                }

                $prefix = $this->isSecure() ? 'https://ssl' : 'http://www';
                $code = $this->getOption('code');

                if ($this->isAsync())
                {
                        $output = '<script type="text/javascript">';
                        $output .= '(function() {';
                        $output .= 'var ga = document.createElement("script"); ga.type = "text/javascript"; ga.async = true;';
                        $output .= "ga.src = '{$prefix}.google-analytics.com/ga.js';";
                        $output .= 'var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(ga, s);';
                        $output .= '})();';
                        $output .= '</script>';
                }
                else
                {
                        $output = '<script type="text/javascript">';
                        $output .= "document.write(unescape(\"%3Cscript src='{$prefix}.google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E\"));";
                        $output .= '</script>';
                        $output .= '<script type="text/javascript">';
                        $output .= 'try{';
                        $output .= "var pageTracker = _gat._getTracker('{$code}');";

                        foreach ($this->listCalls() as $call)
                        {
                                $output .= $this->createCall($call['name'], $call['params']);
                        }

                        $output .= 'pageTracker._trackPageview();';
                        $output .= '} catch(err) {}</script>';
                }

                return $output;
        }

JGoogleEmbedAnalytics::getCode

(

)

Method to get the tracking code

Renvoie:

string The Google Analytics tracking code

Depuis:

12.3

Définition à la ligne 28 du fichier analytics.php.

        {
                return $this->getOption('code');
        }

JGoogleEmbedAnalytics::getHeader

(

)

Get code to load Google Analytics javascript

Renvoie:

string Javascript code

Depuis:

12.3

Réimplémentée à partir de JGoogleEmbed.

Définition à la ligne 255 du fichier analytics.php.

        {
                if (!$this->isAsync())
                {
                        // Synchronous code is included only in the body
                        return '';
                }

                if (!$this->getOption('code'))
                {
                        throw new UnexpectedValueException('A Google Analytics tracking code is required.');
                }

                $code = $this->getOption('code');

                $output = '<script type="text/javascript">';
                $output .= 'var _gaq = _gaq || [];';
                $output .= "_gaq.push(['_setAccount', '{$code}']);";

                foreach ($this->listCalls() as $call)
                {
                        $output .= $this->createCall($call['name'], $call['params']);
                }

                $output .= '_gaq.push(["_trackPageview"]);';
                $output .= '</script>';

                return $output;
        }

JGoogleEmbedAnalytics::isAsync

(

)

Checks if the javascript is set to be asynchronous

Renvoie:

boolean True if asynchronous

Depuis:

12.3

Définition à la ligne 56 du fichier analytics.php.

        {
                return $this->getOption('async') === null ? true : $this->getOption('async');
        }

JGoogleEmbedAnalytics::listCalls

(

)

List the analytics calls to be executed

Renvoie:

array A list of calls

Depuis:

12.3

Définition à la ligne 117 du fichier analytics.php.

        {
                return $this->getOption('calls') ? $this->getOption('calls') : array();
        }

JGoogleEmbedAnalytics::setCode

(

$code

)

Method to set the tracking code

Paramètres:

string

$code

The Google Analytics tracking code

Renvoie:

JGoogleEmbedAnalytics The object for method chaining

Depuis:

12.3

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

        {
                $this->setOption('code', $code);

                return $this;
        }

JGoogleEmbedAnalytics::useAsync

(

)

Load javascript asynchronously

Renvoie:

JGoogleEmbedAnalytics The object for method chaining

Depuis:

12.3

Définition à la ligne 68 du fichier analytics.php.

        {
                $this->setOption('async', true);

                return $this;
        }

JGoogleEmbedAnalytics::useSync

(

)

Load javascript synchronously

Renvoie:

JGoogleEmbedAnalytics The object for method chaining

Depuis:

12.3

Définition à la ligne 82 du fichier analytics.php.

        {
                $this->setOption('async', false);

                return $this;
        }

---

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

• jplatform-13.1/joomla/google/embed/analytics.php