ReportPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.Plugin');
 
abstract class ReportPlugin extends Plugin {
 
   //
   // Public methods to be implemented by subclasses.
   //
   function getMetrics($metricType = null, $columns = array(), $filters = array(), $orderBy = array(), $range = null) {
      return null;
   }
 
   function getMetricTypes() {
      return array();
   }
 
   function getMetricDisplayType($metricType) {
      return null;
   }
 
   function getMetricFullName($metricType) {
      return null;
   }
 
   function getColumns($metricType) {
      return null;
   }
 
   function getOptionalColumns($metricType) {
      return array();
   }
 
   function getObjectTypes($metricType) {
      return null;
   }
 
   function getDefaultReportTemplates($metricTypes = null) {
      return array();
   }
 
 
   //
   // Public methods.
   //
   function getActions($request, $actionArgs) {
      $dispatcher = $request->getDispatcher();
      import('lib.pkp.classes.linkAction.request.RedirectAction');
      return array_merge(
         $this->getEnabled()?array(
            new LinkAction(
               'settings',
               new RedirectAction($dispatcher->url(
                  $request, ROUTE_PAGE,
                  null, 'management', 'tools', 'report', array('pluginName' => $this->getName())
               )),
               __('manager.statistics.reports'),
               null
            )
         ):array(),
         parent::getActions($request, $actionArgs)
      );
   }
}