SampleImportExportPlugin Class Reference
[Plugins_importexport_sample]
Sample import/export plugin.
More...
Public Member Functions | |
| display (&$args) | |
| executeCLI ($scriptName, &$args) | |
| getDescription () | |
| getDisplayName () | |
| getName () | |
| register ($category, $path) | |
| usage ($scriptName) | |
Detailed Description
Sample import/export plugin.Definition at line 20 of file SampleImportExportPlugin.inc.php.
Member Function Documentation
| SampleImportExportPlugin.display | ( | &$ | args | ) |
Display the import/export plugin UI.
- Parameters:
-
$args Array The array of arguments the user supplied.
Reimplemented from ImportExportPlugin.
Definition at line 59 of file SampleImportExportPlugin.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), and Handler.getRangeInfo().
| SampleImportExportPlugin.executeCLI | ( | $ | scriptName, | |
| &$ | args | |||
| ) |
Execute import/export tasks using the command-line interface.
- Parameters:
-
$args Parameters to the plugin
Reimplemented from ImportExportPlugin.
Definition at line 81 of file SampleImportExportPlugin.inc.php.
References usage().
| SampleImportExportPlugin.getDescription | ( | ) |
Get a description of the plugin.
Reimplemented from ImportExportPlugin.
Definition at line 55 of file SampleImportExportPlugin.inc.php.
References Locale.translate().
| SampleImportExportPlugin.getDisplayName | ( | ) |
Get the display name of this plugin. This name is displayed on the Journal Manager's import/export page, for example.
- Returns:
- String
Reimplemented from ImportExportPlugin.
Definition at line 51 of file SampleImportExportPlugin.inc.php.
References Locale.translate().
| SampleImportExportPlugin.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 46 of file SampleImportExportPlugin.inc.php.
| SampleImportExportPlugin.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 27 of file SampleImportExportPlugin.inc.php.
References Plugin.addLocaleData().
| SampleImportExportPlugin.usage | ( | $ | scriptName | ) |
Display the command-line usage information
Reimplemented from ImportExportPlugin.
Definition at line 88 of file SampleImportExportPlugin.inc.php.
Referenced by executeCLI().
The documentation for this class was generated from the following file:
- plugins/importexport/sample/SampleImportExportPlugin.inc.php
