classes/plugins/ImportExportPlugin.inc.php

Go to the documentation of this file.

<?php

//$Id$

class ImportExportPlugin extends Plugin {
   function ImportExportPlugin() {
      parent::Plugin();
   }

   function getName() {
      // This should not be used as this is an abstract class
      return 'ImportExportPlugin';
   }

   function getDisplayName() {
      // This name should never be displayed because child classes
      // will override this method.
      return 'Abstract Import/Export Plugin';
   }

   function getDescription() {
      return 'This is the ImportExportPlugin base class. Its functions can be overridden by subclasses to provide import/export functionality for various formats.';
   }

   function setBreadcrumbs($crumbs = array(), $isSubclass = false) {
      $templateMgr =& TemplateManager::getManager();
      $pageCrumbs = array(
         array(
            Request::url(null, null, 'user'),
            'navigation.user'
         ),
         array(
            Request::url(null, null, 'manager'),
            'user.role.manager'
         ),
         array (
            Request::url(null, null, 'manager', 'importexport'),
            'manager.importExport'
         )
      );
      if ($isSubclass) $pageCrumbs[] = array(
         Request::url(null, null, 'manager', 'importexport', array('plugin', $this->getName())),
         $this->getDisplayName(),
         true
      );

      $templateMgr->assign('pageHierarchy', array_merge($pageCrumbs, $crumbs));
   }

   function display(&$args) {
      $templateManager =& TemplateManager::getManager();
      $templateManager->register_function('plugin_url', array(&$this, 'smartyPluginUrl'));
   }

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

   function usage($scriptName) {
      // Implemented by subclasses
   }

   function manage($verb, $args) {
      if ($verb === 'importexport') {
         Request::redirect(null, null, 'manager', 'importexport', array('plugin', $this->getName()));
      }
      return false;
   }

   function smartyPluginUrl($params, &$smarty) {
      $path = array('plugin', $this->getName());
      if (is_array($params['path'])) {
         $params['path'] = array_merge($path, $params['path']);
      } elseif (!empty($params['path'])) {
         $params['path'] = array_merge($path, array($params['path']));
      } else {
         $params['path'] = $path;
      }
      return $smarty->smartyUrl($params, $smarty);
   }

}
?>

---