Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Application Class Reference
Inheritance diagram for Application:
PKPApplication

Public Member Functions

 getContextDepth ()
 
 getDAOMap ()
 
 getDefaultMetricType ()
 
 getMetrics ($metricType=null, $columns=array(), $filter=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ($withDisplayNames=false)
 
 getName ()
 
 getNameKey ()
 
 getPluginCategories ()
 
 getPrimaryMetricByAssoc ($assocType, $assocId)
 
 getVersionDescriptorUrl ()
 
instantiateHelp ()
 
- Public Member Functions inherited from PKPApplication
 buildErrorMessage ($errorno, $errstr, $errfile, $errline)
 
 defineExposedConstant ($name, $value)
 
 errorHandler ($errorno, $errstr, $errfile, $errline)
 
 execute ()
 
getApplication ()
 
 getContextDepth ()
 
 getContextList ()
 
getCurrentVersion ()
 
 getDAOMap ()
 
getDispatcher ()
 
getEnabledProducts ($category=null, $mainContextId=null)
 
getExposedConstants ()
 
 getJSLocaleKeys ()
 
 getName ()
 
 getNameKey ()
 
 getPluginCategories ()
 
 getQualifiedDAOName ($name)
 
getRequest ()
 
 getVersionDescriptorUrl ()
 
instantiateHelp ()
 

Detailed Description

Class describing this application.

See Also
PKPApplication

Definition at line 36 of file Application.inc.php.

Member Function Documentation

Application::getContextDepth ( )

Get the "context depth" of this application, i.e. the number of parts of the URL after index.php that represent the context of the current request (e.g. Journal [1], or Conference and Scheduled Conference [2]).

Returns
int

Definition at line 48 of file Application.inc.php.

Application::getDAOMap ( )

Get the map of DAOName => full.class.Path for this application.

Returns
array

Definition at line 84 of file Application.inc.php.

Application::getDefaultMetricType ( )

Returns the currently configured default metric type for this site. If no specific metric type has been set for this site then null will be returned.

Returns
null|string A metric type identifier or null if no default metric type could be identified.

Definition at line 224 of file Application.inc.php.

References getMetricTypes(), and PKPApplication\getRequest().

Referenced by getMetrics().

Application::getMetrics (   $metricType = null,
  $columns = array(),
  $filter = array(),
  $orderBy = array(),
  $range = null 
)

Main entry point for OJS statistics reports.

See Also
http://pkp.sfu.ca/wiki/index.php/OJSdeStatisticsConcept#Input_and_Output_Formats_.28Aggregation.2C_Filters.2C_Metrics_Data.29 for a full specification of the input and output format of this method.
Parameters
$metricTypenull|string|array metrics selection NB: If you want to use the default metric on journal level then you must set $metricType = null and add an explicit filter on a single journal ID. Otherwise the default site-level metric will be used.
$columnsstring|array column (aggregation level) selection
$filtersarray report-level filter selection
$orderByarray order criteria
$rangenull|DBResultRange paging specification
Returns
null|array The selected data as a simple tabular result set or null if the given parameter combination is not supported.

Definition at line 263 of file Application.inc.php.

References StatisticsHelper\canonicalizeMetricTypes(), StatisticsHelper\getContext(), getDefaultMetricType(), getMetricTypes(), and PluginRegistry\loadCategory().

Referenced by getPrimaryMetricByAssoc().

Application::getMetricTypes (   $withDisplayNames = false)

Return all metric types supported by this application.

Returns
array An array of strings of supported metric type identifiers.

Definition at line 195 of file Application.inc.php.

References PluginRegistry\loadCategory().

Referenced by getDefaultMetricType(), and getMetrics().

Application::getName ( )

Get the symbolic name of this application

Returns
string

Definition at line 59 of file Application.inc.php.

Application::getNameKey ( )

Get the locale key for the name of this application.

Returns
string

Definition at line 67 of file Application.inc.php.

Application::getPluginCategories ( )

Get the list of plugin categories for this application.

Definition at line 147 of file Application.inc.php.

Application::getPrimaryMetricByAssoc (   $assocType,
  $assocId 
)

Return metric in the primary metric type for the passed associated object.

Parameters
$assocTypeint
$assocIdint
Returns
int

Definition at line 334 of file Application.inc.php.

References getMetrics(), and PKPApplication\getRequest().

Application::getVersionDescriptorUrl ( )

Get the URL to the XML descriptor for the current version of this application.

Returns
string

Definition at line 76 of file Application.inc.php.

& Application::instantiateHelp ( )

Instantiate the help object for this application.

Returns
object

Definition at line 180 of file Application.inc.php.


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