Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
BackupPlugin Class Reference
Inheritance diagram for BackupPlugin:
GenericPlugin

Public Member Functions

 addLink ($hookName, $args)
 
 getDescription ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getManagementVerbs ()
 
 getName ()
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams)
 
 register ($category, $path)
 
- Public Member Functions inherited from GenericPlugin
 GenericPlugin ()
 
 getManagementVerbs ($verbs=array())
 
 manage ($verb, $args, &$message, &$messageParams)
 
- Public Member Functions inherited from LazyLoadPlugin
 getEnabled ()
 
 getName ()
 
 LazyLoadPlugin ()
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 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, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Plugin to allow generation of a backup extract.

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

Member Function Documentation

BackupPlugin::addLink (   $hookName,
  $args 
)

Hook callback function for TemplateManager::display

Parameters
$hookNamestring
$argsarray
Returns
boolean

Definition at line 51 of file BackupPlugin.inc.php.

References PKPApplication\getRequest().

BackupPlugin::getDescription ( )

Get the description of this plugin

Returns
string

Definition at line 144 of file BackupPlugin.inc.php.

BackupPlugin::getDisplayName ( )

Get the display name of this plugin

Returns
string

Definition at line 136 of file BackupPlugin.inc.php.

Referenced by manage().

BackupPlugin::getEnabled ( )

Check whether or not this plugin is enabled

Returns
boolean

Definition at line 152 of file BackupPlugin.inc.php.

References Plugin\getSetting().

Referenced by getManagementVerbs(), and register().

BackupPlugin::getManagementVerbs ( )

Get a list of available management verbs for this plugin

Returns
array

Definition at line 160 of file BackupPlugin.inc.php.

References getEnabled().

BackupPlugin::getName ( )

Get the symbolic name of this plugin

Returns
string

Definition at line 128 of file BackupPlugin.inc.php.

BackupPlugin::isSitePlugin ( )

Designate this plugin as a site plugin

Definition at line 41 of file BackupPlugin.inc.php.

BackupPlugin::manage (   $verb,
  $args,
$message,
$messageParams 
)
See Also
PKPPlugin::manage()

Definition at line 170 of file BackupPlugin.inc.php.

References getDisplayName(), and Plugin\updateSetting().

BackupPlugin::register (   $category,
  $path 
)

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

Parameters
$categorystring
$pathstring
Returns
boolean

Definition at line 26 of file BackupPlugin.inc.php.

References PKPPlugin\addLocaleData(), getEnabled(), Validation\isSiteAdmin(), and HookRegistry\register().


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