UsageStatsOptoutBlockPlugin Class Reference

Inheritance diagram for UsageStatsOptoutBlockPlugin:

Public Member Functions
	__construct ($usageStatsPlugin)
	getBlockTemplateFilename ()
	getContents ($templateMgr, $request=null)
	getDescription ()
	getDisplayName ()
	getEnabled ($contextId=null)
	getHideManagement ()
	getName ()
	getPluginPath ()
	isSitePlugin ()
Public Member Functions inherited from BlockPlugin
	setEnabled ($enabled, $contextId=null)
Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	register ($category, $path, $mainContextId=null)
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	getTemplatePath ($inCore=false)
	getTemplateResource ($template=null, $inCore=false)
	import ($class)
	installContextSpecificSettings ($hookName, $args)
	installControlledVocabs ($hookName, $args)
	installData ($hookName, $args)
	installEmailTemplateData ($hookName, $args)
	installEmailTemplates ($hookName, $args)
	installFilters ($hookName, $args)
	installLocale ($hookName, $args)
	installSiteSettings ($hookName, $args)
	manage ($args, $request)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Protected Attributes
	$_usageStatsPlugin

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Opt-out component.

Definition at line 18 of file UsageStatsOptoutBlockPlugin.inc.php.

Constructor & Destructor Documentation

__construct()

UsageStatsOptoutBlockPlugin::__construct

(

$usageStatsPlugin

)

Constructor

Parameters

$usageStatsPlugin

UsageStatsPlugin

Definition at line 29 of file UsageStatsOptoutBlockPlugin.inc.php.

Member Function Documentation

getBlockTemplateFilename()

UsageStatsOptoutBlockPlugin::getBlockTemplateFilename

(

)

copydoc BlockPlugin::getBlockTemplateFilename()

Reimplemented from BlockPlugin.

Definition at line 93 of file UsageStatsOptoutBlockPlugin.inc.php.

Referenced by getContents().

getContents()

UsageStatsOptoutBlockPlugin::getContents	(		$templateMgr,
			$request = null
	)

Get the HTML contents for this block.

Parameters

$templateMgr	object
$request	PKPRequest (Optional for legacy plugins)

Returns

string

Reimplemented from BlockPlugin.

Definition at line 86 of file UsageStatsOptoutBlockPlugin.inc.php.

References getBlockTemplateFilename(), and Plugin\getTemplateResource().

getDescription()

UsageStatsOptoutBlockPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 58 of file UsageStatsOptoutBlockPlugin.inc.php.

getDisplayName()

UsageStatsOptoutBlockPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 51 of file UsageStatsOptoutBlockPlugin.inc.php.

getEnabled()

UsageStatsOptoutBlockPlugin::getEnabled

(

$contextId = null

)

Determine whether the plugin is enabled.

Returns

boolean

Reimplemented from BlockPlugin.

Definition at line 79 of file UsageStatsOptoutBlockPlugin.inc.php.

getHideManagement()

UsageStatsOptoutBlockPlugin::getHideManagement

(

)

Determine whether or not this plugin should be hidden from the management interface. Useful in the case of derivative plugins, i.e. when a generic plugin registers a feed plugin.

Returns

boolean

Reimplemented from Plugin.

Definition at line 37 of file UsageStatsOptoutBlockPlugin.inc.php.

getName()

UsageStatsOptoutBlockPlugin::getName

(

)

Protected methods (may be overridden by custom plugins) 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 LazyLoadPlugin.

Definition at line 44 of file UsageStatsOptoutBlockPlugin.inc.php.

getPluginPath()

UsageStatsOptoutBlockPlugin::getPluginPath

(

)

Get the path this plugin's files are located in.

Returns

String pathname

Reimplemented from Plugin.

Definition at line 72 of file UsageStatsOptoutBlockPlugin.inc.php.

isSitePlugin()

UsageStatsOptoutBlockPlugin::isSitePlugin

(

)

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

Returns

boolean

Reimplemented from Plugin.

Definition at line 65 of file UsageStatsOptoutBlockPlugin.inc.php.

Field Documentation

$_usageStatsPlugin

UsageStatsPlugin UsageStatsOptoutBlockPlugin::$_usageStatsPlugin

protected

Definition at line 23 of file UsageStatsOptoutBlockPlugin.inc.php.

---

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

• UsageStatsOptoutBlockPlugin.inc.php