UserImportExportPlugin Class Reference
[Plugins_importexport_users]

Users import/export plugin. More...

Inheritance diagram for UserImportExportPlugin:

ImportExportPlugin Plugin List of all members.

Public Member Functions

 display (&$args)
 executeCLI ($scriptName, &$args)
 getDescription ()
 getDisplayName ()
 getName ()
 register ($category, $path)
 usage ($scriptName)

Detailed Description

Users import/export plugin.

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


Member Function Documentation

UserImportExportPlugin.display ( &$  args  ) 

Display the import/export plugin UI.

Parameters:
$args Array The array of arguments the user supplied.

Reimplemented from ImportExportPlugin.

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

References UserExportDom.exportUsers(), RoleDAO.getRoleIdFromPath(), Request.getSchedConf(), Plugin.getTemplatePath(), and ImportExportPlugin.setBreadcrumbs().

UserImportExportPlugin.executeCLI ( scriptName,
&$  args 
)

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

Parameters:
$args Parameters to the plugin

Reimplemented from ImportExportPlugin.

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

References UserExportDom.exportUsers(), and usage().

UserImportExportPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from ImportExportPlugin.

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

UserImportExportPlugin.getDisplayName (  ) 

Get the display name of this plugin. This name is displayed on the Conference Manager's import/export page, for example.

Returns:
String

Reimplemented from ImportExportPlugin.

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

UserImportExportPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented from ImportExportPlugin.

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

Referenced by usage().

UserImportExportPlugin.register ( category,
path 
)

Called as a plugin is registered to the registry

Parameters:
$category String Name of category plugin was registered to
Returns:
boolean True iff plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

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

UserImportExportPlugin.usage ( scriptName  ) 

Display the command-line usage information

Reimplemented from ImportExportPlugin.

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

References getName().

Referenced by executeCLI().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7