Open Journal Systems  3.3.0
UserImportExportPlugin Class Reference
Inheritance diagram for UserImportExportPlugin:
PKPUserImportExportPlugin ImportExportPlugin Plugin

Public Member Functions

 executeCLI ($scriptName, &$args)
 
 register ($category, $path, $mainContextId=null)
 
 usage ($scriptName)
 
- Public Member Functions inherited from PKPUserImportExportPlugin
 display ($args, $request)
 
 exportAllUsers ($context, $user, &$filter=null)
 
 exportUsers ($ids, $context, $user, &$filter=null)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getPluginSettingsPrefix ()
 
 getUserImportExportFilter ($context, $user, $isImport=true)
 
 importUsers ($importXml, $context, $user, &$filter=null)
 
- Public Member Functions inherited from ImportExportPlugin
 displayXMLValidationErrors ($errors, $xml)
 
 getActions ($request, $actionArgs)
 
 getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')
 
 getExportPath ()
 
 isAllowedMethod ($url)
 
 isRelativePath ($url)
 
 pluginUrl ($params, $smarty)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCanDisable ()
 
 getCanEnable ()
 
 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 ImportExportPlugin
 $_request
 
- Data Fields inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 
- Protected Member Functions inherited from Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

User XML import/export plugin.

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

Member Function Documentation

◆ executeCLI()

UserImportExportPlugin::executeCLI (   $scriptName,
$args 
)

◆ register()

UserImportExportPlugin::register (   $category,
  $path,
  $mainContextId = null 
)

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
$mainContextIdinteger To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.
Returns
boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from PKPUserImportExportPlugin.

Definition at line 23 of file UserImportExportPlugin.inc.php.

◆ usage()

UserImportExportPlugin::usage (   $scriptName)

Reimplemented from ImportExportPlugin.

Definition at line 30 of file UserImportExportPlugin.inc.php.

References PKPUserImportExportPlugin\getName().

Referenced by executeCLI().


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