plugins/generic/jquery/JQueryPlugin.inc.php

Go to the documentation of this file.

<?php

// $Id$


import('classes.plugins.GenericPlugin');

define('JQUERY_INSTALL_PATH', 'lib' . DIRECTORY_SEPARATOR . 'pkp' . DIRECTORY_SEPARATOR . 'js' . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'jquery');
define('JQUERY_JS_PATH', JQUERY_INSTALL_PATH . DIRECTORY_SEPARATOR . 'jquery.min.js');

class JQueryPlugin extends GenericPlugin {
   function register($category, $path) {
      if (parent::register($category, $path)) {
         $this->addLocaleData();
         if ($this->isJQueryInstalled()) {
            HookRegistry::register('TemplateManager::display', array(&$this, 'displayCallback'));
            $user =& Request::getUser();
            if ($user) HookRegistry::register('Templates::Common::Footer::PageFooter', array(&$this, 'footerCallback'));
            $templateMgr =& TemplateManager::getManager();
            $templateMgr->addStyleSheet(Request::getBaseUrl() . '/lib/pkp/styles/jqueryUi.css');
            $templateMgr->addStyleSheet(Request::getBaseUrl() . '/lib/pkp/styles/jquery.pnotify.default.css');
            $templateMgr->addStyleSheet(Request::getBaseUrl() . '/lib/pkp/styles/themes/default/pnotify.css');
         }
         return true;
      }
      return false;
   }

   function getScriptPath() {
      return Request::getBaseUrl() . DIRECTORY_SEPARATOR . JQUERY_JS_PATH;
   }

   function getEnabledScripts($page, $op) {
      $scripts = array();
      switch ("$page/$op") {
         case 'admin/conferences':
         case 'manager/schedConfs':
         case 'manager/groupMembership':
         case 'manager/groups':
         case 'manager/reviewFormElements':
         case 'manager/reviewForms':
         case 'manager/sections':
         case 'manager/subscriptionTypes':
         case 'rtadmin/contexts':
         case 'rtadmin/searches':
         case 'registrationManager/registrationTypes':
            $scripts[] = 'plugins/generic/jquery/scripts/jquery.tablednd_0_5.js';
            $scripts[] = 'plugins/generic/jquery/scripts/tablednd.js';
            break;
      }
      $user =& Request::getUser();
      if ($user) $scripts[] = 'lib/pkp/js/jquery.pnotify.js';
      return $scripts;
   }

   function displayCallback($hookName, $args) {
      $page = Request::getRequestedPage();
      $op = Request::getRequestedOp();
      $scripts = JQueryPlugin::getEnabledScripts($page, $op);
      if(empty($scripts)) return null;

      $templateManager =& $args[0];
      $additionalHeadData = $templateManager->get_template_vars('additionalHeadData');
      $baseUrl = $templateManager->get_template_vars('baseUrl');

      $jQueryScript = JQueryPlugin::addScripts($baseUrl, $scripts);

      $templateManager->assign('additionalHeadData', $additionalHeadData."\n".$jQueryScript);
   }

   function jsEscape($string) {
      return strtr($string, array('\\'=>'\\\\',"'"=>"\\'",'"'=>'\\"',"\r"=>'\\r',"\n"=>'\\n','</'=>'<\/'));
   }

   function footerCallback($hookName, $args) {
      $output =& $args[2];
      $notificationDao =& DAORegistry::getDAO('NotificationDAO');
      $user =& Request::getUser();
      $notificationsMarkup = '';

      $notifications =& $notificationDao->getNotificationsByUserId($user->getId(), NOTIFICATION_LEVEL_TRIVIAL);
      while ($notification =& $notifications->next()) {
         $notificationTitle = $notification->getTitle();
         if ($notification->getIsLocalized() && !empty($notificationTitle)) $notificationTitle = __($notificationTitle);
         if (empty($notificationTitle)) $notificationTitle = __('notification.notification');
         $notificationsMarkup .= '$.pnotify({pnotify_title: \'' . $this->jsEscape($notificationTitle) . '\', pnotify_text: \'';
         if ($notification->getIsLocalized()) $notificationsMarkup .= $this->jsEscape(__($notification->getContents(), array('param' => $notification->getParam())));
         else $notificationsMarkup .= $this->jsEscape($notification->getContents());
         $notificationsMarkup .= '\', pnotify_addclass: \'' . $this->jsEscape($notification->getStyleClass());
         $notificationsMarkup .= '\', pnotify_notice_icon: \'notifyIcon ' . $this->jsEscape($notification->getIconClass());
         $notificationsMarkup .= '\'});';
         $notificationDao->deleteNotificationById($notification->getId());
         unset($notification);
      }
      if (!empty($notificationsMarkup)) $notificationsMarkup = "<script type=\"text/javascript\">$notificationsMarkup</script>\n";

      $output .= $notificationsMarkup;
      return false;
   }

   function addScripts($baseUrl, $scripts) {
      $scriptOpen = '   <script language="javascript" type="text/javascript" src="';
      $scriptClose = '"></script>';
      $returner = '';

      foreach ($scripts as $script) {
         if(file_exists(Core::getBaseDir() . DIRECTORY_SEPARATOR . $script)) {
            $returner .= $scriptOpen . $baseUrl . '/' . $script . $scriptClose . "\n";
         }
      }
      return $returner;
   }

   function getName() {
      return 'JQueryPlugin';
   }

   function getDisplayName() {
      return __('plugins.generic.jquery.name');
   }

   function getDescription() {
      if ($this->isJQueryInstalled()) return __('plugins.generic.jquery.description');
      return __('plugins.generic.jquery.descriptionDisabled', array('jQueryPath' => JQUERY_INSTALL_PATH));
   }

   function isJQueryInstalled() {
      // We may not register jQuery when the application is not yet installed
      // as access to the template manager (see register method) requires db access.
      return Config::getVar('general', 'installed') && file_exists(JQUERY_JS_PATH);
   }
}

?>

---