Open Journal Systems  3.3.0
Journal Class Reference
Inheritance diagram for Journal:
Context DataObject

Public Member Functions

 getAssocType ()
 
 getDAO ()
 
 getDefaultMetricType ()
 
 getLocalizedPageHeaderLogo ()
 
 getLocalizedPageHeaderTitle ()
 
 getMetrics ($metricType=null, $columns=array(), $filter=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ($withDisplayNames=false)
 
- Public Member Functions inherited from Context
 getAcronym ($locale)
 
 getContactEmail ()
 
 getContactName ()
 
 getDateTimeFormats ($format)
 
 getDescription ($locale=null)
 
 getEnabled ()
 
 getLocalizedAcronym ()
 
 getLocalizedDateFormatLong ($locale=null)
 
 getLocalizedDateFormatShort ($locale=null)
 
 getLocalizedDateTimeFormatLong ($locale=null)
 
 getLocalizedDateTimeFormatShort ($locale=null)
 
 getLocalizedDescription ()
 
 getLocalizedFavicon ()
 
 getLocalizedName ($preferredLocale=null)
 
 getLocalizedSetting ($name, $locale=null)
 
 getLocalizedTimeFormat ($locale=null)
 
 getName ($locale=null)
 
 getPath ()
 
 getPrimaryLocale ()
 
 getSequence ()
 
 getSetting ($name, $locale=null)
 
 getSupportedFormLocaleNames ()
 
 getSupportedFormLocales ()
 
 getSupportedLocaleNames ()
 
 getSupportedLocales ()
 
 getSupportedSubmissionLocaleNames ()
 
 getSupportedSubmissionLocales ()
 
 getViews ()
 
 setContactEmail ($contactEmail)
 
 setContactName ($contactName)
 
 setDescription ($description, $locale=null)
 
 setEnabled ($enabled)
 
 setName ($name, $locale=null)
 
 setPath ($path)
 
 setPrimaryLocale ($primaryLocale)
 
 setSequence ($sequence)
 
 updateSetting ($name, $value, $type=null, $isLocalized=false)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Describes basic journal properties.

See also
JournalDAO

Definition at line 30 of file Journal.inc.php.

Member Function Documentation

◆ getAssocType()

Journal::getAssocType ( )

Get the association type for this context.

Returns
int

Reimplemented from Context.

Definition at line 66 of file Journal.inc.php.

◆ getDAO()

Journal::getDAO ( )

Get DAO class name for this object.

Returns
DAO

Reimplemented from DataObject.

Definition at line 73 of file Journal.inc.php.

References DAORegistry\getDAO().

◆ getDefaultMetricType()

Journal::getDefaultMetricType ( )

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

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

Reimplemented from Context.

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

References $application, PKPApplication\get(), DataObject\getData(), and getMetricTypes().

◆ getLocalizedPageHeaderLogo()

Journal::getLocalizedPageHeaderLogo ( )

Get "localized" journal page logo (if applicable).

Returns
string

Definition at line 50 of file Journal.inc.php.

References DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

◆ getLocalizedPageHeaderTitle()

Journal::getLocalizedPageHeaderTitle ( )

Get "localized" journal page title (if applicable).

Returns
string

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

References DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

◆ getMetrics()

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

Retrieve a statistics report pre-filtered on this journal.

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|integer|array metrics selection
$columnsinteger|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 metrics are not supported by this journal.

Reimplemented from Context.

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

References $application, PKPApplication\get(), and DataObject\getId().

◆ getMetricTypes()

Journal::getMetricTypes (   $withDisplayNames = false)

Return all metric types supported by this journal.

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

Reimplemented from Context.

Definition at line 86 of file Journal.inc.php.

References DataObject\getId(), and PluginRegistry\loadCategory().

Referenced by getDefaultMetricType().


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