RecommendBySimilarityPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.GenericPlugin');
 
define('RECOMMEND_BY_SIMILARITY_PLUGIN_COUNT', 10);
 
class RecommendBySimilarityPlugin extends GenericPlugin {
 
   //
   // Implement template methods from Plugin.
   //
   function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return $success;
 
      if ($success && $this->getEnabled($mainContextId)) {
         HookRegistry::register('Templates::Article::Footer::PageFooter', array($this, 'callbackTemplateArticlePageFooter'));
      }
      return $success;
   }
 
   function getDisplayName() {
      return __('plugins.generic.recommendBySimilarity.displayName');
   }
 
   function getDescription() {
      return __('plugins.generic.recommendBySimilarity.description');
   }
 
 
   //
   // View level hook implementations.
   //
   function callbackTemplateArticlePageFooter($hookName, $params) {
      $smarty =& $params[1];
      $output =& $params[2];
 
      // Identify similarity terms for the given article.
      $displayedArticle = $smarty->getTemplateVars('article');
      $articleId = $displayedArticle->getId();
      import('classes.search.ArticleSearch');
      $articleSearch = new ArticleSearch();
      $searchTerms = $articleSearch->getSimilarityTerms($articleId);
      if (empty($searchTerms)) return false;
 
      // If we got similarity terms then execute a search with...
      // ... request, journal and error messages, ...
      $request = Application::get()->getRequest();
      $router = $request->getRouter();
      $journal = $router->getContext($request);
      $error = null;
      // ... search keywords ...
      $query = implode(' ', $searchTerms);
      $keywords = array(null => $query);
      // ... and pagination.
      $rangeInfo = Handler::getRangeInfo($request, 'articlesBySimilarity');
      $rangeInfo->setCount(RECOMMEND_BY_SIMILARITY_PLUGIN_COUNT);
      $smarty->assign(array(
         'articlesBySimilarity' => $articleSearch->retrieveResults(
               $request,
               $journal,
               $keywords,
               $error,
               null, null,
               $rangeInfo,
               array($articleId)
         ),
         'articlesBySimilarityQuery' => $query,
      ));
      $output .= $smarty->fetch($this->getTemplateResource('articleFooter.tpl'));
      return false;
   }
}