• Home
  • NativeImportExportPlugin

PHP Class NativeImportExportPlugin, ojs

Inheritance: extends ImportExportPlugin
Show file Open project: pkp/ojs

Public Methods

Method Description
__construct ( ) Constructor
display ( $args, $request ) Display the plugin.
executeCLI ( $scriptName, &$args )
exportIssues ( $issueIds, $context, $user ) : string Get the XML for a set of issues.
exportSubmissions ( $submissionIds, $context, $user ) : string Get the XML for a set of submissions.
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 )
importSubmissions ( $importXml, $filter, $deployment ) : array Get the XML for a set of submissions wrapped in a(n) issue(s).
register ( $category, $path ) : boolean Called as a plugin is registered to the registry
usage ( $scriptName )

Method Details

__construct() public method

Constructor
public __construct ( )

display() public method

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

executeCLI() public method

See also: PKPImportExportPlugin::executeCLI()
public executeCLI ( $scriptName, &$args )

exportIssues() public method

Get the XML for a set of issues.
public exportIssues ( $issueIds, $context, $user ) : string
$issueIds array Array of issue IDs
$context Context
$user User
return string XML contents representing the supplied issue IDs.

exportSubmissions() public method

Get the XML for a set of submissions.
public exportSubmissions ( $submissionIds, $context, $user ) : string
$submissionIds array Array of submission IDs
$context Context
$user User|null
return string XML contents representing the supplied submission 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 )

importSubmissions() public method

Get the XML for a set of submissions wrapped in a(n) issue(s).
public importSubmissions ( $importXml, $filter, $deployment ) : array
$importXml string XML contents to import
$filter string Filter to be used
$deployment PKPImportExportDeployment
return array Set of imported submissions

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.

usage() public method

public usage ( $scriptName )