ThesisPlugin Class Reference
[Plugins_generic_thesis]

Thesis abstracts plugin class. More...

Inheritance diagram for ThesisPlugin:

List of all members.

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

---

Detailed Description

Thesis abstracts plugin class.

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

---

Member Function Documentation

ThesisPlugin.getDescription

(

)

Get a description of this plugin.

Reimplemented from Plugin.

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

References Locale.translate().

ThesisPlugin.getDisplayName

(

)

Get the display name for this plugin.

Returns:

string

Reimplemented from Plugin.

Definition at line 61 of file ThesisPlugin.inc.php.

References Locale.translate().

Referenced by setBreadcrumbs().

ThesisPlugin.getEnabled

(

)

Determine whether or not this plugin is enabled.

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

References Request.getJournal().

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

ThesisPlugin.getInstallDataFile

(

)

Get the filename of the install data for this plugin.

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

ThesisPlugin.getInstallSchemaFile

(

)

Get the filename of the ADODB schema for this plugin.

Reimplemented from Plugin.

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

References Plugin.getPluginPath().

ThesisPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

Definition at line 132 of file ThesisPlugin.inc.php.

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

ThesisPlugin.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 57 of file ThesisPlugin.inc.php.

Referenced by manage(), setBreadcrumbs(), and smartyPluginUrl().

ThesisPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 219 of file ThesisPlugin.inc.php.

References DAORegistry.getDAO(), getEnabled(), Request.getJournal(), TemplateManager.getManager(), getName(), Handler.getRangeInfo(), Request.getUserDateVar(), Request.getUserVar(), Request.redirect(), and setEnabled().

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

References Plugin.addLocaleData(), getEnabled(), HookRegistry.register(), and DAORegistry.registerDAO().

ThesisPlugin.setBreadcrumbs

(

$

isSubclass = false

)

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

Parameters:

$subclass

boolean

Definition at line 108 of file ThesisPlugin.inc.php.

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

ThesisPlugin.setEnabled

(

$

enabled

)

Set the enabled/disabled state of this plugin

Definition at line 207 of file ThesisPlugin.inc.php.

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

Referenced by manage().

ThesisPlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

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

Reimplemented from Plugin.

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

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

---

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

• plugins/generic/thesis/ThesisPlugin.inc.php