1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
<?php
/**
* @file SampleImportExportPlugin.inc.php
*
* Copyright (c) 2003-2009 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class SampleImportExportPlugin
* @ingroup plugins_importexport_sample
*
* @brief Sample import/export plugin
*/
// $Id$
import('classes.plugins.ImportExportPlugin');
class SampleImportExportPlugin extends ImportExportPlugin {
/**
* Called as a plugin is registered to the registry
* @param $category String Name of category plugin was registered to
* @return boolean True iff plugin initialized successfully; if false,
* the plugin will not be registered.
*/
function register($category, $path) {
$success = parent::register($category, $path);
// Additional registration / initialization code
// should go here. For example, load additional locale data:
$this->addLocaleData();
// This is fixed to return false so that this coding sample
// isn't actually registered and displayed. If you're using
// this sample for your own code, make sure you return true
// if everything is successfully initialized.
// return $success;
return false;
}
/**
* Get the name of this plugin. The name must be unique within
* its category.
* @return String name of plugin
*/
function getName() {
// This should not be used as this is an abstract class
return 'SampleImportExportPlugin';
}
function getDisplayName() {
return Locale::translate('plugins.importexport.sample.displayName');
}
function getDescription() {
return Locale::translate('plugins.importexport.sample.description');
}
function display(&$args) {
parent::display($args);
switch (array_shift($args)) {
case 'exportIssue':
// The actual issue export code would go here
break;
default:
// Display a list of issues for export
$journal = &Request::getJournal();
$issueDao = &DAORegistry::getDAO('IssueDAO');
$issues = &$issueDao->getIssues($journal->getJournalId(), Handler::getRangeInfo('issues'));
$templateMgr = &TemplateManager::getManager();
$templateMgr->assign_by_ref('issues', $issues);
$templateMgr->display($this->getTemplatePath() . 'issues.tpl');
}
}
/**
* Execute import/export tasks using the command-line interface.
* @param $args Parameters to the plugin
*/
function executeCLI($scriptName, &$args) {
$this->usage($scriptName);
}
/**
* Display the command-line usage information
*/
function usage($scriptName) {
echo "USAGE NOT AVAILABLE.\n"
. "This is a sample plugin and does not actually perform a function.\n";
}
}
?>
|
