Open Journal Systems  3.3.0
DefaultThemePlugin Class Reference
Inheritance diagram for DefaultThemePlugin:
ThemePlugin LazyLoadPlugin Plugin

Public Member Functions

 getContextSpecificPluginSettingsFile ()
 
 getDescription ()
 
 getDisplayName ()
 
 getInstallSitePluginSettingsFile ()
 
 init ()
 
 isActive ()
 
- Public Member Functions inherited from ThemePlugin
 _getBaseDir ($path='')
 
 _getBaseUrl ($path='')
 
 _registerScripts ()
 
 addMenuArea ($menuAreas)
 
 addOption ($name, $type, $args=array())
 
 addScript ($name, $script, $args=array())
 
 addStyle ($name, $style, $args=array())
 
 getMenuAreas ($existingAreas=array())
 
 getOption ($name)
 
 getOptionConfig ($name)
 
 getOptionsConfig ()
 
 getOptionValues ($contextId)
 
getScript ($name)
 
getStyle ($name)
 
 initAfter ()
 
 isColourDark ($color, $limit=130)
 
 modifyOptionsConfig ($name, $args=array())
 
 modifyScript ($name, $args=array())
 
 modifyStyle ($name, $args=array())
 
 register ($category, $path, $mainContextId=null)
 
 removeMenuArea ($menuArea)
 
 removeOption ($name)
 
 removeScript ($name)
 
 removeStyle ($name)
 
 saveOption ($name, $value, $contextId=null)
 
 setParent ($parent)
 
 themeRegistered ($themes)
 
 validateOptions ($options, $themePluginPath, $contextId, $request)
 
- Public Member Functions inherited from LazyLoadPlugin
 getCanDisable ()
 
 getCanEnable ()
 
 getCurrentContextId ()
 
 getEnabled ($contextId=null)
 
 getName ()
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getActions ($request, $actionArgs)
 
 getCategory ()
 
 getCurrentVersion ()
 
 getDirName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getLocaleFilename ($locale)
 
 getPluginPath ()
 
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)
 
 isSitePlugin ()
 
 manage ($args, $request)
 
 smartyPluginUrl ($params, $smarty)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Data Fields inherited from ThemePlugin
 $menuAreas = array()
 
 $options = array()
 
 $parent
 
 $scripts = array()
 
 $styles = array()
 
- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 
- Protected Attributes inherited from ThemePlugin
 $_optionValues = null
 

Detailed Description

Default theme.

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

Member Function Documentation

◆ getContextSpecificPluginSettingsFile()

DefaultThemePlugin::getContextSpecificPluginSettingsFile ( )

Get the name of the settings file to be installed on new journal creation.

Returns
string

Reimplemented from Plugin.

Definition at line 247 of file DefaultThemePlugin.inc.php.

References Plugin\getPluginPath().

◆ getDescription()

DefaultThemePlugin::getDescription ( )

Get the description of this plugin

Returns
string

Reimplemented from Plugin.

Definition at line 272 of file DefaultThemePlugin.inc.php.

◆ getDisplayName()

DefaultThemePlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Reimplemented from Plugin.

Definition at line 264 of file DefaultThemePlugin.inc.php.

◆ getInstallSitePluginSettingsFile()

DefaultThemePlugin::getInstallSitePluginSettingsFile ( )

Get the name of the settings file to be installed site-wide when OJS is installed.

Returns
string

Reimplemented from Plugin.

Definition at line 256 of file DefaultThemePlugin.inc.php.

References Plugin\getPluginPath().

◆ init()

DefaultThemePlugin::init ( )

Initialize the theme's styles, scripts and hooks. This is run on the currently active theme and it's parent themes.

Returns
null

Reimplemented from ThemePlugin.

Definition at line 33 of file DefaultThemePlugin.inc.php.

References Plugin\$request, ThemePlugin\addMenuArea(), ThemePlugin\addOption(), ThemePlugin\addScript(), ThemePlugin\addStyle(), PKPApplication\get(), ThemePlugin\getOption(), Config\getVar(), ThemePlugin\isColourDark(), ThemePlugin\modifyStyle(), and AppLocale\requireComponents().

◆ isActive()

DefaultThemePlugin::isActive ( )

Determine whether or not this plugin is currently active

This only returns true if the theme is currently the selected theme in a given context. Use self::getEnabled() if you want to know if the theme is available for use on the site.

Returns
boolean

Reimplemented from ThemePlugin.

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


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