CSVImportExportPlugin Class Reference

Inheritance diagram for CSVImportExportPlugin:

Public Member Functions
	__construct ()
	display ($args, $request)
	executeCLI ($scriptName, &$args)
	getActions ($request, $actionArgs)
	getDescription ()
	getDisplayName ()
	getName ()
	register ($category, $path, $mainContextId=null)
	usage ($scriptName)
Public Member Functions inherited from ImportExportPlugin
	displayXMLValidationErrors ($errors, $xml)
	getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')
	getExportPath ()
	getPluginSettingsPrefix ()
	isAllowedMethod ($url)
	isRelativePath ($url)
	pluginUrl ($params, $smarty)
Public Member Functions inherited from Plugin
	_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

CSV import/export plugin.

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

Constructor & Destructor Documentation

__construct()

CSVImportExportPlugin::__construct

(

)

Constructor

Reimplemented from Plugin.

Definition at line 22 of file CSVImportExportPlugin.inc.php.

Member Function Documentation

display()

CSVImportExportPlugin::display	(		$args,
			$request
	)

Display the plugin.

Parameters

$args	array
$request	PKPRequest

Reimplemented from ImportExportPlugin.

Definition at line 64 of file CSVImportExportPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

executeCLI()

CSVImportExportPlugin::executeCLI	(		$scriptName,
		&	$args
	)

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

Parameters

$args

Parameters to the plugin

Reimplemented from ImportExportPlugin.

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

References Application\getContextDAO(), Core\getCurrentDate(), DAORegistry\getDAO(), AppLocale\requireComponents(), and usage().

getActions()

CSVImportExportPlugin::getActions	(		$request,
			$actionArgs
	)

Get a list of link actions for plugin management.

Parameters

request	PKPRequest
$actionArgs	array The list of action args to be included in request URLs.

Returns

array List of LinkActions

Reimplemented from ImportExportPlugin.

Definition at line 55 of file CSVImportExportPlugin.inc.php.

getDescription()

CSVImportExportPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 48 of file CSVImportExportPlugin.inc.php.

getDisplayName()

CSVImportExportPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

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

getName()

CSVImportExportPlugin::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 40 of file CSVImportExportPlugin.inc.php.

Referenced by usage().

register()

CSVImportExportPlugin::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.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

Definition at line 29 of file CSVImportExportPlugin.inc.php.

References Plugin\addLocaleData().

usage()

CSVImportExportPlugin::usage

(

$scriptName

)

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 263 of file CSVImportExportPlugin.inc.php.

References getName().

Referenced by executeCLI().

---

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

• CSVImportExportPlugin.inc.php