Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
SampleImportExportPlugin Class Reference
Inheritance diagram for SampleImportExportPlugin:
ImportExportPlugin Plugin PKPPlugin

Public Member Functions

 executeCLI ($scriptName, &$args)
 
 getName ()
 
 register ($category, $path)
 
 usage ($scriptName)
 
- Public Member Functions inherited from ImportExportPlugin
 display (&$args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getManagementVerbs ()
 
 getName ()
 
 ImportExportPlugin ()
 
 manage ($verb, $args, $message, $messageParams=null, $request=null)
 
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
 usage ($scriptName)
 
- 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

Sample import/export plugin.

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

Member Function Documentation

SampleImportExportPlugin::executeCLI (   $scriptName,
$args 
)

Execute import/export tasks using the command-line interface.

Parameters
$argsParameters to the plugin

Definition at line 79 of file SampleImportExportPlugin.inc.php.

References usage().

SampleImportExportPlugin::getName ( )

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

Returns
String name of plugin

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

SampleImportExportPlugin::register (   $category,
  $path 
)

Called as a plugin is registered to the registry

Parameters
$categoryString Name of category plugin was registered to
Returns
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 25 of file SampleImportExportPlugin.inc.php.

References PKPPlugin\addLocaleData().

SampleImportExportPlugin::usage (   $scriptName)

Display the command-line usage information

Definition at line 86 of file SampleImportExportPlugin.inc.php.

Referenced by executeCLI().


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