GoogleAnalyticsPlugin Class Reference
[Plugins_generic_googleAnalytics]

Google Analytics plugin class. More...

Inheritance diagram for GoogleAnalyticsPlugin:

List of all members.

Public Member Functions
	getDescription ()
	getDisplayName ()
	getEnabled ()
	getManagementVerbs ()
	getName ()
	insertFooter ($hookName, $params)
	manage ($verb, $args)
	register ($category, $path)
	setBreadcrumbs ($isSubclass=false)
	setEnabled ($enabled)
	smartyPluginUrl ($params, &$smarty)

---

Detailed Description

Google Analytics plugin class.

Definition at line 20 of file GoogleAnalyticsPlugin.inc.php.

---

Member Function Documentation

GoogleAnalyticsPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from Plugin.

Definition at line 68 of file GoogleAnalyticsPlugin.inc.php.

References Locale.translate().

GoogleAnalyticsPlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

Definition at line 64 of file GoogleAnalyticsPlugin.inc.php.

References Locale.translate().

GoogleAnalyticsPlugin.getEnabled

(

)

Determine whether or not this plugin is enabled.

Definition at line 143 of file GoogleAnalyticsPlugin.inc.php.

References Request.getJournal().

Referenced by getManagementVerbs(), insertFooter(), and manage().

GoogleAnalyticsPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

Definition at line 120 of file GoogleAnalyticsPlugin.inc.php.

References getEnabled(), and Locale.translate().

GoogleAnalyticsPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns:

String name of plugin

Reimplemented from Plugin.

Definition at line 60 of file GoogleAnalyticsPlugin.inc.php.

Referenced by smartyPluginUrl().

GoogleAnalyticsPlugin.insertFooter	(	$	hookName,
		$	params
	)

Insert Google Analytics page tag to footer

Definition at line 164 of file GoogleAnalyticsPlugin.inc.php.

References getEnabled(), Request.getJournal(), and TemplateManager.getManager().

GoogleAnalyticsPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 193 of file GoogleAnalyticsPlugin.inc.php.

References getEnabled(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), and setEnabled().

GoogleAnalyticsPlugin.register	(	$	category,
		$	path
	)

Called as a plugin is registered to the registry

Parameters:

$category

String Name of category plugin was registered to

Returns:

boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

Definition at line 28 of file GoogleAnalyticsPlugin.inc.php.

References Plugin.addLocaleData(), Config.getVar(), and HookRegistry.register().

GoogleAnalyticsPlugin.setBreadcrumbs

(

$

isSubclass = false

)

Set the page's breadcrumbs, given the plugin's tree of items to append.

Parameters:

$subclass

boolean

Definition at line 97 of file GoogleAnalyticsPlugin.inc.php.

References TemplateManager.getManager(), and Request.url().

GoogleAnalyticsPlugin.setEnabled

(

$

enabled

)

Set the enabled/disabled state of this plugin

Definition at line 152 of file GoogleAnalyticsPlugin.inc.php.

References Request.getJournal(), and Plugin.updateSetting().

Referenced by manage().

GoogleAnalyticsPlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

Extend the {url ...} smarty to support this plugin.

Reimplemented from Plugin.

Definition at line 75 of file GoogleAnalyticsPlugin.inc.php.

References Plugin.getCategory(), and getName().

---

The documentation for this class was generated from the following file:

• plugins/generic/googleAnalytics/GoogleAnalyticsPlugin.inc.php