Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPToolsHandler Class Reference
Inheritance diagram for PKPToolsHandler:
ManagementHandler Handler PKPHandler ToolsHandler

Public Member Functions

 generateReport ($args, $request)
 
 index ($args, $request)
 
 PKPToolsHandler ()
 
 report ($args, $request)
 
 reportGenerator ($args, $request)
 
 saveStatisticsSettings ($args, $request)
 
 statisticcs ($args, $request)
 
 tools ($args, $request)
 
- Public Member Functions inherited from ManagementHandler
 authorize ($request, &$args, $roleAssignments)
 
 initialize ($request, $args=null)
 
 ManagementHandler ()
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Protected Member Functions

 getObjectTitle ($assocId, $assocType)
 
 getReportRowValue ($key, $record)
 
 hasAppStatsSettings ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Handle requests for Tool pages.

Definition at line 18 of file PKPToolsHandler.inc.php.

Member Function Documentation

PKPToolsHandler::generateReport (   $args,
  $request 
)

Generate statistics reports from passed request arguments.

Parameters
$argsarray
$requestPKPRequest

Definition at line 149 of file PKPToolsHandler.inc.php.

References Application\getContextAssocType(), getObjectTitle(), getReportRowValue(), and AppLocale\requireComponents().

Referenced by tools().

PKPToolsHandler::getObjectTitle (   $assocId,
  $assocType 
)
protected

Get data object title based on passed assoc type and id.

Parameters
$assocIdint
$assocTypeint
Returns
string

Definition at line 340 of file PKPToolsHandler.inc.php.

References Application\getContextAssocType(), Application\getContextDAO(), DAORegistry\getDAO(), Application\getSectionDAO(), and Application\getSubmissionDAO().

Referenced by generateReport().

PKPToolsHandler::getReportRowValue (   $key,
  $record 
)
protected

Get the row value based on the column key (usually assoc types) and the current record.

Parameters
$keystring|int
$recordarray
Returns
string

Definition at line 329 of file PKPToolsHandler.inc.php.

Referenced by generateReport().

PKPToolsHandler::hasAppStatsSettings ( )
protected

Override and return true if application has more statistics settings than the defined in library.

Returns
boolean

Definition at line 372 of file PKPToolsHandler.inc.php.

Referenced by statisticcs().

PKPToolsHandler::index (   $args,
  $request 
)

Display tools index page.

Parameters
$requestPKPRequest
$argsarray

Definition at line 74 of file PKPToolsHandler.inc.php.

Referenced by tools().

PKPToolsHandler::PKPToolsHandler ( )

Constructor.

Definition at line 22 of file PKPToolsHandler.inc.php.

References PKPHandler\addRoleAssignment().

PKPToolsHandler::report (   $args,
  $request 
)

Delegates to plugins operations related to report generation.

Parameters
$argsarray
$requestRequest

Definition at line 114 of file PKPToolsHandler.inc.php.

References PluginRegistry\loadCategory(), and PKPRequest\redirect().

Referenced by tools().

PKPToolsHandler::reportGenerator (   $args,
  $request 
)

Display page to generate custom reports.

Parameters
$argsarray
$requestRequest

Definition at line 133 of file PKPToolsHandler.inc.php.

References AppLocale\requireComponents().

Referenced by tools().

PKPToolsHandler::saveStatisticsSettings (   $args,
  $request 
)

Save statistics settings. @

Definition at line 302 of file PKPToolsHandler.inc.php.

Referenced by tools().

PKPToolsHandler::statisticcs (   $args,
  $request 
)

Display the

Parameters
$argsarray
$requestPKPRequest

Definition at line 85 of file PKPToolsHandler.inc.php.

References hasAppStatsSettings(), and PluginRegistry\loadCategory().

Referenced by tools().

PKPToolsHandler::tools (   $args,
  $request 
)

Route to other Tools operations

Parameters
$argsarray
$requestPKPRequest

Definition at line 44 of file PKPToolsHandler.inc.php.

References generateReport(), index(), report(), reportGenerator(), saveStatisticsSettings(), and statisticcs().


The documentation for this class was generated from the following file: