CounterPlugin Class Reference
[Plugins_generic_counter]

COUNTER plugin; provides COUNTER-compliant statistics. More...

Inheritance diagram for CounterPlugin:

List of all members.

Public Member Functions
	getDescription ()
	getDisplayName ()
	getManagementVerbs ()
	getName ()
	isSitePlugin ()
	logRequest ($hookName, $args)
	manage ($verb, $args)
	register ($category, $path)

---

Detailed Description

COUNTER plugin; provides COUNTER-compliant statistics.

Definition at line 21 of file CounterPlugin.inc.php.

---

Member Function Documentation

CounterPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from Plugin.

Definition at line 59 of file CounterPlugin.inc.php.

References Plugin.addLocaleData(), and Locale.translate().

CounterPlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

Definition at line 54 of file CounterPlugin.inc.php.

References Plugin.addLocaleData(), and Locale.translate().

CounterPlugin.getManagementVerbs

(

)

Get a list of management actions in the form of a page => value pair. The management actions from this list are passed to the manage() function when called.

Reimplemented from Plugin.

Definition at line 163 of file CounterPlugin.inc.php.

References Plugin.addLocaleData(), Validation.isSiteAdmin(), and Locale.translate().

CounterPlugin.getName

(

)

Get the name of this plugin. The name must be unique within its category.

Returns:

String name of plugin

Reimplemented from Plugin.

Definition at line 50 of file CounterPlugin.inc.php.

CounterPlugin.isSitePlugin

(

)

Site-wide plugins should override this function to return true.

Reimplemented from Plugin.

Definition at line 159 of file CounterPlugin.inc.php.

CounterPlugin.logRequest	(	$	hookName,
		$	args
	)

Log the request. This follows a convoluted execution path in order to obtain the page title *after* the template has been displayed, even though the hook is called before execution.

Definition at line 82 of file CounterPlugin.inc.php.

References Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getSession(), Request.getSite(), Request.getUserVar(), and Request.url().

CounterPlugin.manage	(	$	verb,
		$	args
	)

Perform a management function.

Reimplemented from Plugin.

Definition at line 183 of file CounterPlugin.inc.php.

References Plugin.addLocaleData(), Validation.isSiteAdmin(), Request.redirect(), and Plugin.updateSetting().

CounterPlugin.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 CounterPlugin.inc.php.

References HookRegistry.register(), and DAORegistry.registerDAO().

---

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

• plugins/generic/counter/CounterPlugin.inc.php