Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ThemePlugin Class Reference
Inheritance diagram for ThemePlugin:
DefaultThemePlugin

Public Member Functions

 _displayCssCallback ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getLessStylesheet ()
 
 getStyleCacheFilename ()
 
 register ($category, $path)
 
 ThemePlugin ()
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Abstract class for theme plugins.

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

Member Function Documentation

ThemePlugin::_displayCssCallback (   $hookName,
  $args 
)

Called as a callback upon stylesheet compilation. Used to inject this theme's styles.

Definition at line 83 of file ThemePlugin.inc.php.

References Plugin\$request, HookRegistry\call(), getLessStylesheet(), Plugin\getName(), Plugin\getPluginPath(), and getStyleCacheFilename().

ThemePlugin::getDescription ( )

Get a description of the plugin.

Definition at line 56 of file ThemePlugin.inc.php.

ThemePlugin::getDisplayName ( )

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

Returns
String

Definition at line 49 of file ThemePlugin.inc.php.

ThemePlugin::getLessStylesheet ( )

Get the filename to this theme's stylesheet, or null if none.

Returns
string|null

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

Referenced by _displayCssCallback(), and getStyleCacheFilename().

ThemePlugin::getStyleCacheFilename ( )

Get the compiled CSS cache filename

Returns
string|null

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

References getLessStylesheet(), and Plugin\getName().

Referenced by _displayCssCallback().

ThemePlugin::register (   $category,
  $path 
)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters
$categoryString Name of category plugin was registered to
$pathString The path the plugin was found in
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

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

References Plugin\$request, Plugin\getName(), Plugin\getRequest(), and HookRegistry\register().

ThemePlugin::ThemePlugin ( )

Constructor

Definition at line 22 of file ThemePlugin.inc.php.


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