ImmersionThemePlugin Class Reference

Inheritance diagram for ImmersionThemePlugin:

Public Member Functions
	addIssueDAOFieldNames ($hookName, $args)
	addIssueTemplateData ($hookname, $args)
	addSiteWideData ($hookname, $args)
	addToIssueForm ($hookName, $args)
	executeIssueFormFields ($hookName, $args)
	getDescription ()
	getDisplayName ()
	hasEmbeddedCSS ($hookName, $args)
	homepageAnnouncements ($hookname, $args)
	homepageJournalDescription ($hookName, $args)
	init ()
	initDataIssueFormFields ($hookName, $args)
	readIssueFormFields ($hookName, $args)
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 ()
	isActive ()
	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 ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	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

Immersion theme.

Definition at line 17 of file ImmersionThemePlugin.inc.php.

Member Function Documentation

addIssueDAOFieldNames()

ImmersionThemePlugin::addIssueDAOFieldNames	(		$hookName,
			$args
	)

Add section settings to IssueDAO

Parameters

$hookName	string
$args	array [ @option IssueDAO @option array List of additional fields ]

Definition at line 331 of file ImmersionThemePlugin.inc.php.

addIssueTemplateData()

ImmersionThemePlugin::addIssueTemplateData	(		$hookname,
			$args
	)

Add section-specific data to the indexJournal and issue templates.

Parameters

$hookname	string
$args	array [ @option TemplateManager @option string relative path to the template ]

Definition at line 134 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), AppLocale\getLocale(), ThemePlugin\getOption(), PKPApplication\getRequest(), Plugin\getRequest(), and ThemePlugin\isColourDark().

addSiteWideData()

ImmersionThemePlugin::addSiteWideData	(		$hookname,
			$args
	)

Assign additional data to Smarty templates.

Parameters

$hookname	string
$args	array [ @option TemplateManager @option string relative path to the template ]

Returns

void

Definition at line 259 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, Plugin\getPluginPath(), Plugin\getRequest(), Config\getVar(), and PKPString\regexp_replace().

addToIssueForm()

ImmersionThemePlugin::addToIssueForm	(		$hookName,
			$args
	)

Add variables to the issue editing form

Parameters

$hookName	string issueform::display; see fetch()
$args	array [ @option IssueForm ]

Definition at line 402 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), PKPTemplateManager\getManager(), and Plugin\getRequest().

executeIssueFormFields()

ImmersionThemePlugin::executeIssueFormFields	(		$hookName,
			$args
	)

Save additional fields in the issue editing form

Parameters

$hookName	string issueform::execute
$args	array [ @option IssueForm @option Issue @option Request ]

Definition at line 376 of file ImmersionThemePlugin.inc.php.

References DAORegistry\getDAO().

getDescription()

ImmersionThemePlugin::getDescription

(

)

Get the description of this plugin

Returns

string

Reimplemented from Plugin.

Definition at line 121 of file ImmersionThemePlugin.inc.php.

getDisplayName()

ImmersionThemePlugin::getDisplayName

(

)

Get the display name of this theme

Returns

string

Reimplemented from Plugin.

Definition at line 113 of file ImmersionThemePlugin.inc.php.

hasEmbeddedCSS()

ImmersionThemePlugin::hasEmbeddedCSS	(		$hookName,
			$args
	)

Parameters

$hookName	string TemplateManager::display
$args	array [ @option TemplateManager @option string relative path to the template ]

Definition at line 425 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), and Plugin\getRequest().

homepageAnnouncements()

ImmersionThemePlugin::homepageAnnouncements	(		$hookname,
			$args
	)

background color for announcements section on the journal index page

Parameters

$hookname	string
$args	array [ @option TemplateManager @option string relative path to the template ]

Returns

boolean|void

Definition at line 224 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, ThemePlugin\getOption(), Plugin\getRequest(), and ThemePlugin\isColourDark().

homepageJournalDescription()

ImmersionThemePlugin::homepageJournalDescription	(		$hookName,
			$args
	)

Show Journal Description on the journal landing page depending on theme settings.

Parameters

$hookname	string
$args	array [ @option TemplateManager @option string relative path to the template ]

Returns

boolean|void

Definition at line 303 of file ImmersionThemePlugin.inc.php.

References ThemePlugin\getOption(), and ThemePlugin\isColourDark().

init()

ImmersionThemePlugin::init

(

)

The primary method themes should use to add styles, scripts and fonts, or register hooks. This method is only fired for the currently active theme.

Returns

null

Reimplemented from ThemePlugin.

Definition at line 19 of file ImmersionThemePlugin.inc.php.

References ThemePlugin\addMenuArea(), ThemePlugin\addOption(), ThemePlugin\addScript(), ThemePlugin\addStyle(), and HookRegistry\register().

initDataIssueFormFields()

ImmersionThemePlugin::initDataIssueFormFields	(		$hookName,
			$args
	)

Initialize data when form is first loaded

Parameters

$hookName

string issueform::initData @parram $args array [ @option IssueForm ]

Definition at line 345 of file ImmersionThemePlugin.inc.php.

readIssueFormFields()

ImmersionThemePlugin::readIssueFormFields	(		$hookName,
			$args
	)

$$ Read user input from additional fields in the issue editing form

Parameters

$hookName

string issueform::readUserVars @parram $args array [ @option IssueForm @option array User vars ]

Definition at line 359 of file ImmersionThemePlugin.inc.php.

References Plugin\$request, and Plugin\getRequest().

---

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

• ImmersionThemePlugin.inc.php