CustomThemePlugin Class Reference
[Plugins_themes_uncommon]

"Custom" theme plugin More...

Inheritance diagram for CustomThemePlugin:

ThemePlugin Plugin

List of all members.

Public Member Functions

 getDescription ()
 getDisplayName ()
 getManagementVerbs ()
 getName ()
 register ($category, $path)
 setBreadcrumbs ($isSubclass=false)
 smartyPluginUrl ($params, &$smarty)


Detailed Description

"Custom" theme plugin

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


Member Function Documentation

CustomThemePlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from ThemePlugin.

Definition at line 48 of file CustomThemePlugin.inc.php.

References Locale.translate().

CustomThemePlugin.getDisplayName (  ) 

Get the display name of this plugin. This name is displayed on the Journal Manager's setup page 5, for example.

Returns:
String

Reimplemented from ThemePlugin.

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

References Locale.translate().

CustomThemePlugin.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 56 of file CustomThemePlugin.inc.php.

References Locale.translate().

CustomThemePlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented from ThemePlugin.

Definition at line 40 of file CustomThemePlugin.inc.php.

Referenced by smartyPluginUrl().

CustomThemePlugin.register ( category,
path 
)

Register the plugin, if enabled; note that this plugin runs under both Journal and Site contexts.

Parameters:
$category string
$path string
Returns:
boolean

Reimplemented from Plugin.

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

References Plugin.addLocaleData().

CustomThemePlugin.setBreadcrumbs ( isSubclass = false  ) 

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

Parameters:
$subclass boolean

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

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

CustomThemePlugin.smartyPluginUrl ( params,
&$  smarty 
)

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

Reimplemented from Plugin.

Definition at line 88 of file CustomThemePlugin.inc.php.

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


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

Generated on Mon Jul 14 10:55:41 2008 for Open Journal Systems by  doxygen 1.5.6