Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
Journal Class Reference
Inheritance diagram for Journal:
DataObject

Public Member Functions

 getDefaultMetricType ()
 
 getDescription ($locale)
 
 getEnabled ()
 
 getInitials ($locale)
 
 getJournalId ()
 
 getLocalizedDescription ()
 
 getLocalizedFavicon ()
 
 getLocalizedInitials ()
 
 getLocalizedPageHeaderLogo ($home=false)
 
 getLocalizedPageHeaderTitle ($home=false)
 
getLocalizedSetting ($name, $preferredLocale=null)
 
 getLocalizedTitle ($preferredLocale=null)
 
 getMetrics ($metricType=null, $columns=array(), $filter=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ($withDisplayNames=false)
 
 getPath ()
 
 getPrimaryLocale ()
 
 getSequence ()
 
getSetting ($name, $locale=null)
 
getSettings ()
 
getSupportedFormLocaleNames ()
 
getSupportedLocaleNames ()
 
getSupportedSubmissionLocaleNames ()
 
 getTitle ($locale)
 
 getUrl ()
 
 Journal ()
 
 setEnabled ($enabled)
 
 setJournalId ($journalId)
 
 setPath ($path)
 
 setPrimaryLocale ($primaryLocale)
 
 setSequence ($sequence)
 
 updateSetting ($name, $value, $type=null, $isLocalized=false)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Describes basic journal properties.

See Also
JournalDAO

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

Member Function Documentation

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.

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

References PKPApplication\getApplication(), getMetricTypes(), and getSetting().

Journal::getDescription (   $locale)

Get description of journal.

Parameters
$localestring
Returns
string

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

References getSetting().

Journal::getEnabled ( )

Get enabled flag of journal

Returns
int

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

References DataObject\getData().

Journal::getInitials (   $locale)

Get the initials of the journal.

Parameters
$localestring
Returns
string

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

References getSetting().

Journal::getJournalId ( )

Get ID of journal.

Returns
int

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

References DataObject\getId(), and Config\getVar().

Journal::getLocalizedDescription ( )

Get the localized description of the journal.

Returns
string

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

References getLocalizedSetting().

Journal::getLocalizedFavicon ( )

Get localized favicon

Returns
string

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and getSetting().

Journal::getLocalizedInitials ( )

Get localized initials of journal

Returns
string

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

References getLocalizedSetting().

Journal::getLocalizedPageHeaderLogo (   $home = false)

Get "localized" journal page logo (if applicable). param $home boolean get homepage logo

Returns
string

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and getSetting().

Journal::getLocalizedPageHeaderTitle (   $home = false)

Get "localized" journal page title (if applicable). param $home boolean get homepage title

Returns
string

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and getSetting().

& Journal::getLocalizedSetting (   $name,
  $preferredLocale = null 
)

Retrieve a localized setting.

Parameters
$namestring
$preferredLocalestring
Returns
mixed

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and getSetting().

Referenced by getLocalizedDescription(), getLocalizedInitials(), and getLocalizedTitle().

Journal::getLocalizedTitle (   $preferredLocale = null)

Get the localized title of the journal.

Parameters
$preferredLocalestring
Returns
string

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

References getLocalizedSetting().

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
$filterarray 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.

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

References PKPApplication\getApplication(), and DataObject\getId().

Journal::getMetricTypes (   $withDisplayNames = false)

Return all metric types supported by this journal.

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

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

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

Referenced by getDefaultMetricType().

Journal::getPath ( )

Get path to journal (in URL).

Returns
string

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

References DataObject\getData().

Referenced by getUrl().

Journal::getPrimaryLocale ( )

Return the primary locale of this journal.

Returns
string

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

References DataObject\getData().

Referenced by getSupportedSubmissionLocaleNames().

Journal::getSequence ( )

Get sequence of journal in site table of contents.

Returns
float

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

References DataObject\getData().

& Journal::getSetting (   $name,
  $locale = null 
)
& Journal::getSettings ( )

Retrieve array of journal settings.

Returns
array

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

References DAORegistry\getDAO(), and DataObject\getId().

& Journal::getSupportedFormLocaleNames ( )

Return associative array of all locales supported by forms of the journal. These locales are used to provide a language toggle on the journal-specific pages.

Returns
array

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

References PKPLocale\getAllLocales(), DataObject\getData(), and getSetting().

& Journal::getSupportedLocaleNames ( )

Return associative array of all locales supported by the journal. These locales are used to provide a language toggle on the journal-specific pages.

Returns
array

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

References PKPLocale\getAllLocales(), DataObject\getData(), and getSetting().

& Journal::getSupportedSubmissionLocaleNames ( )

Return associative array of all locales supported for the submissions. These locales are used to provide a language toggle on the submission setp1 and the galley edit page.

Returns
array

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

References PKPLocale\getAllLocales(), DataObject\getData(), getPrimaryLocale(), and getSetting().

Journal::getTitle (   $locale)

Get title of journal

Parameters
$localestring
Returns
string

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

References getSetting().

Journal::getUrl ( )

Get the base URL to the journal.

Returns
string

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

References getPath(), and Request\url().

Journal::Journal ( )

Constructor.

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

Journal::setEnabled (   $enabled)

Set enabled flag of journal

Parameters
$enabledint

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

References DataObject\setData().

Journal::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

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

References Config\getVar(), and DataObject\setId().

Journal::setPath (   $path)

Set path to journal (in URL).

Parameters
$pathstring

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

References DataObject\setData().

Journal::setPrimaryLocale (   $primaryLocale)

Set the primary locale of this journal.

Parameters
$primaryLocalestring

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

References DataObject\setData().

Journal::setSequence (   $sequence)

Set sequence of journal in site table of contents.

Parameters
$sequencefloat

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

References DataObject\setData().

Journal::updateSetting (   $name,
  $value,
  $type = null,
  $isLocalized = false 
)

Update a journal setting value.

Parameters
$namestring
$valuemixed
$typestring optional
$isLocalizedboolean optional

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

References DAORegistry\getDAO(), and DataObject\getId().


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