plugins/importexport/sample/SampleImportExportPlugin.inc.php

<?php

// $Id: SampleImportExportPlugin.inc.php,v 1.15 2008/07/01 01:16:14 asmecher Exp $


import('classes.plugins.ImportExportPlugin');

class SampleImportExportPlugin extends ImportExportPlugin {
   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;
   }

   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');
      }
   }

   function executeCLI($scriptName, &$args) {
      $this->usage($scriptName);
   }

   function usage($scriptName) {
      echo "USAGE NOT AVAILABLE.\n"
         . "This is a sample plugin and does not actually perform a function.\n";
   }
}

?>

---