• Home
  • PKPUserImportExportPlugin

PHP Class PKPUserImportExportPlugin, pkp-lib

Inheritance: extends ImportExportPlugin
Show file Open project: pkp/pkp-lib Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
display ( $args, $request ) Display the plugin.
exportAllUsers ( $context, $user ) : string Get the XML for all of users.
exportUsers ( $ids, $context, $user ) : string Get the XML for a set of users.
getDescription ( ) : string Get the display description.
getDisplayName ( ) : string Get the display name.
getName ( ) : String Get the name of this plugin. The name must be unique within its category.
getPluginSettingsPrefix ( )
getTemplatePath ( $inCore = false )
importUsers ( $importXml, $context, $user ) : array Get the XML for a set of users.
register ( $category, $path ) : boolean Called as a plugin is registered to the registry

Method Details

__construct() public method

Constructor
public __construct ( )

display() public method

Display the plugin.
public display ( $args, $request )
$args array
$request PKPRequest

exportAllUsers() public method

Get the XML for all of users.
public exportAllUsers ( $context, $user ) : string
$context Context
$user User
return string XML contents representing the supplied user IDs.

exportUsers() public method

Get the XML for a set of users.
public exportUsers ( $ids, $context, $user ) : string
$ids array mixed Array of users or user IDs
$context Context
$user User
return string XML contents representing the supplied user IDs.

getDescription() public method

Get the display description.
public getDescription ( ) : string
return string

getDisplayName() public method

Get the display name.
public getDisplayName ( ) : string
return string

getName() public method

Get the name of this plugin. The name must be unique within its category.
public getName ( ) : String
return String name of plugin

getPluginSettingsPrefix() public method

public getPluginSettingsPrefix ( )

getTemplatePath() public method

public getTemplatePath ( $inCore = false )

importUsers() public method

Get the XML for a set of users.
public importUsers ( $importXml, $context, $user ) : array
$importXml string XML contents to import
$context Context
$user User
return array Set of imported users

register() public method

Called as a plugin is registered to the registry
public register ( $category, $path ) : boolean
$category String Name of category plugin was registered to
$path string
return boolean True iff plugin initialized successfully; if false, the plugin will not be registered.