PHP Class Journal, ojs

Inheritance: extends Strass_Db_Table_Row_Abstract, implements Zend_Acl_Resource_Interface
Datei anzeigen Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor.
getAssocType ( ) : integer Get the association type for this context.
getDAO ( )
getDefaultMetricType ( ) : null | string Returns the currently configured default metric type for this journal.
getLocalizedFavicon ( ) : string Get localized favicon
getLocalizedPageHeaderLogo ( ) : string Get "localized" journal page logo (if applicable).
getLocalizedPageHeaderTitle ( ) : string Get "localized" journal page title (if applicable).
getMetricTypes ( $withDisplayNames = false ) : array Return all metric types supported by this journal.
getMetrics ( $metricType = null, $columns = [], $filter = [], $orderBy = [], $range = null ) : null | array Retrieve a statistics report pre-filtered on this journal.
getSettingsDAO ( ) : DAO Get the settings DAO for this context object.

Method Details

__construct() public method

Constructor.
public __construct ( )

getAssocType() public method

Get the association type for this context.
public getAssocType ( ) : integer
return integer

getDAO() public method

public getDAO ( )

getDefaultMetricType() public method

If no specific metric type has been set for this journal then the site-wide default metric type will be returned.
public getDefaultMetricType ( ) : null | string
return null | string A metric type identifier or null if no default metric type could be identified.

getLocalizedFavicon() public method

Get localized favicon
public getLocalizedFavicon ( ) : string
return string

getLocalizedPageHeaderTitle() public method

Get "localized" journal page title (if applicable).
public getLocalizedPageHeaderTitle ( ) : string
return string

getMetricTypes() public method

Return all metric types supported by this journal.
public getMetricTypes ( $withDisplayNames = false ) : array
return array An array of strings of supported metric type identifiers.

getMetrics() public method

Retrieve a statistics report pre-filtered on this journal.
See also: for a full specification of the input and output format of this method.
public getMetrics ( $metricType = null, $columns = [], $filter = [], $orderBy = [], $range = null ) : null | array
$metricType null|integer|array metrics selection
$columns integer|array column (aggregation level) selection
$orderBy array order criteria
$range null|DBResultRange paging specification
return null | array The selected data as a simple tabular result set or null if metrics are not supported by this journal.

getSettingsDAO() static public method

Get the settings DAO for this context object.
static public getSettingsDAO ( ) : DAO
return DAO