Inheritance diagram for PKPUserImportExportPlugin:

Public Member Functions
	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)

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

Public Member Functions inherited from ImportExportPlugin
	displayXMLValidationErrors ($errors, $xml)

	executeCLI ($scriptName, &$args)

	getActions ($request, $actionArgs)

	getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')

	getExportPath ()

	isAllowedMethod ($url)

	isRelativePath ($url)

	pluginUrl ($params, $smarty)

	usage ($scriptName)

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

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

Member Function Documentation

◆ display()

PKPUserImportExportPlugin::display	(	$args,
		$request
	)

Display the plugin.

Parameters

$args	array
$request	PKPRequest

Reimplemented from ImportExportPlugin.

Definition at line 67 of file PKPUserImportExportPlugin.inc.php.

References Plugin\$request, exportAllUsers(), exportUsers(), DAORegistry\getDAO(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), PKPTemplateManager\getManager(), getName(), Plugin\getTemplateResource(), getUserImportExportFilter(), and importUsers().

◆ exportAllUsers()

PKPUserImportExportPlugin::exportAllUsers	(		$context,
			$user,
		&	$filter = `null`
	)

Get the XML for all of users.

Parameters

$context	Context
$user	User
$filter	Filter byRef parameter - import/export filter used

Returns: string XML contents representing the supplied user IDs.

Definition at line 175 of file PKPUserImportExportPlugin.inc.php.

References exportUsers(), DAORegistry\getDAO(), and getUserImportExportFilter().

Referenced by display(), and UserImportExportPlugin\executeCLI().

◆ exportUsers()

PKPUserImportExportPlugin::exportUsers	(		$ids,
			$context,
			$user,
		&	$filter = `null`
	)

Get the XML for a set of users.

Parameters

$ids	array mixed Array of users or user IDs
$context	Context
$user	User
$filter	Filter byRef parameter - import/export filter used

Returns: string XML contents representing the supplied user IDs.

Definition at line 193 of file PKPUserImportExportPlugin.inc.php.

References fatalError(), DAORegistry\getDAO(), and getUserImportExportFilter().

Referenced by display(), UserImportExportPlugin\executeCLI(), and exportAllUsers().

◆ getDescription()

PKPUserImportExportPlugin::getDescription ( )

Get the display description.

Returns: string

Reimplemented from Plugin.

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

◆ getDisplayName()

PKPUserImportExportPlugin::getDisplayName ( )

Get the display name.

Returns: string

Reimplemented from Plugin.

Definition at line 43 of file PKPUserImportExportPlugin.inc.php.

◆ getName()

PKPUserImportExportPlugin::getName ( )

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

Returns: String name of plugin

Reimplemented from Plugin.

Definition at line 35 of file PKPUserImportExportPlugin.inc.php.

Referenced by display(), and UserImportExportPlugin\usage().

◆ getPluginSettingsPrefix()

PKPUserImportExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns: string

Reimplemented from ImportExportPlugin.

Definition at line 58 of file PKPUserImportExportPlugin.inc.php.

◆ getUserImportExportFilter()

PKPUserImportExportPlugin::getUserImportExportFilter	(	$context,
		$user,
		$isImport = `true`
	)

Return user filter for import purposes

Parameters

$context	Context
$user	User
$isImport	bool return Import Filter if true - export if false

Returns: Filter

Definition at line 241 of file PKPUserImportExportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by display(), exportAllUsers(), exportUsers(), and importUsers().

◆ importUsers()

PKPUserImportExportPlugin::importUsers	(		$importXml,
			$context,
			$user,
		&	$filter = `null`
	)

Get the XML for a set of users.

Parameters

$importXml	string XML contents to import
$context	Context
$user	User
$filter	Filter byRef parameter - import/export filter used

Returns: array Set of imported users

Definition at line 226 of file PKPUserImportExportPlugin.inc.php.

References getUserImportExportFilter().

Referenced by display(), and UserImportExportPlugin\executeCLI().

◆ register()

PKPUserImportExportPlugin::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

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer 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.