Open Journal Systems
3.3.0
|
Additional Inherited Members | |
Data Fields inherited from DataObject | |
$_data = array() | |
$_extractionAdaptersLoaded = false | |
$_hasLoadableAdapters = false | |
$_injectionAdaptersLoaded = false | |
$_metadataExtractionAdapters = array() | |
$_metadataInjectionAdapters = array() | |
Basic class describing a context.
Definition at line 23 of file Context.inc.php.
Context::getAcronym | ( | $locale | ) |
Get the acronym of the context.
$locale | string |
Definition at line 183 of file Context.inc.php.
References DataObject\getData().
|
abstract |
Context::getContactEmail | ( | ) |
Get the contact email for this context
Definition at line 69 of file Context.inc.php.
References DataObject\getData().
Context::getContactName | ( | ) |
Get the contact name for this context
Definition at line 53 of file Context.inc.php.
References DataObject\getData().
Context::getDateTimeFormats | ( | $format | ) |
Return date or/and time formats available for forms, fallback to the default if not set
$format | string datetime property, e.g., dateFormatShort |
Definition at line 304 of file Context.inc.php.
References DataObject\getData(), getSupportedFormLocales(), and Config\getVar().
Context::getDefaultMetricType | ( | ) |
Returns the currently configured default metric type for this context. If no specific metric type has been set for this context then the site-wide default metric type will be returned.
Reimplemented in Journal.
Definition at line 475 of file Context.inc.php.
References $application, PKPApplication\get(), DataObject\getData(), and getMetricTypes().
Context::getDescription | ( | $locale = null | ) |
Get context description.
$description | string optional |
Definition at line 86 of file Context.inc.php.
References DataObject\getData().
Context::getEnabled | ( | ) |
Get enabled flag of context
Definition at line 119 of file Context.inc.php.
References DataObject\getData().
Context::getLocalizedAcronym | ( | ) |
Get localized acronym of context
Definition at line 174 of file Context.inc.php.
References DataObject\getLocalizedData().
Context::getLocalizedDateFormatLong | ( | $locale = null | ) |
Return localized long date format, fallback to the default if not set
Definition at line 334 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and Config\getVar().
Context::getLocalizedDateFormatShort | ( | $locale = null | ) |
Return localized short date format, fallback to the default if not set
Definition at line 318 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and Config\getVar().
Context::getLocalizedDateTimeFormatLong | ( | $locale = null | ) |
Return localized long date & time format, fallback to the default if not set
Definition at line 382 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and Config\getVar().
Context::getLocalizedDateTimeFormatShort | ( | $locale = null | ) |
Return localized short date & time format, fallback to the default if not set
Definition at line 366 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and Config\getVar().
Context::getLocalizedDescription | ( | ) |
Get the localized description of the context.
Definition at line 166 of file Context.inc.php.
References DataObject\getLocalizedData().
Context::getLocalizedFavicon | ( | ) |
Get localized favicon
Definition at line 191 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().
Context::getLocalizedName | ( | $preferredLocale = null | ) |
Get the localized name of the context
$preferredLocale | string |
Definition at line 30 of file Context.inc.php.
References DataObject\getLocalizedData().
Context::getLocalizedSetting | ( | $name, | |
$locale = null |
|||
) |
Definition at line 412 of file Context.inc.php.
References DataObject\getLocalizedData().
Context::getLocalizedTimeFormat | ( | $locale = null | ) |
Return localized time format, fallback to the default if not set
Definition at line 350 of file Context.inc.php.
References DataObject\getData(), AppLocale\getLocale(), and Config\getVar().
Context::getMetrics | ( | $metricType = null , |
|
$columns = array() , |
|||
$filter = array() , |
|||
$orderBy = array() , |
|||
$range = null |
|||
) |
Retrieve a statistics report pre-filtered on this context.
$metricType | null|integer|array metrics selection |
$columns | integer|array column (aggregation level) selection |
$filters | array report-level filter selection |
$orderBy | array order criteria |
$range | null|DBResultRange paging specification |
Reimplemented in Journal.
Definition at line 511 of file Context.inc.php.
References $application, PKPApplication\get(), and DataObject\getId().
Context::getMetricTypes | ( | $withDisplayNames = false | ) |
Return all metric types supported by this context.
Reimplemented in Journal.
Definition at line 446 of file Context.inc.php.
References DataObject\getId(), and PluginRegistry\loadCategory().
Referenced by getDefaultMetricType().
Context::getName | ( | $locale = null | ) |
get the name of the context
Definition at line 45 of file Context.inc.php.
References DataObject\getData().
Context::getPath | ( | ) |
Get path to context (in URL).
Definition at line 103 of file Context.inc.php.
References DataObject\getData().
Context::getPrimaryLocale | ( | ) |
Return the primary locale of this context.
Definition at line 135 of file Context.inc.php.
References DataObject\getData().
Referenced by EditorialReportNotificationManager\initialize().
Context::getSequence | ( | ) |
Get sequence of context in site-wide list.
Definition at line 150 of file Context.inc.php.
References DataObject\getData().
Context::getSetting | ( | $name, | |
$locale = null |
|||
) |
Definition at line 404 of file Context.inc.php.
References DataObject\getData().
Context::getSupportedFormLocaleNames | ( | ) |
Return associative array of all locales supported by forms on the site. These locales are used to provide a language toggle on the main site pages.
Definition at line 212 of file Context.inc.php.
References PKPLocale\getAllLocales(), DataObject\getData(), and getSupportedFormLocales().
Context::getSupportedFormLocales | ( | ) |
Get the supported form locales.
Definition at line 203 of file Context.inc.php.
References DataObject\getData().
Referenced by getDateTimeFormats(), and getSupportedFormLocaleNames().
Context::getSupportedLocaleNames | ( | ) |
Return associative array of all locales supported by the site. These locales are used to provide a language toggle on the main site pages.
Definition at line 279 of file Context.inc.php.
References PKPLocale\getAllLocales(), DataObject\getData(), and getSupportedLocales().
Context::getSupportedLocales | ( | ) |
Get the supported locales.
Definition at line 270 of file Context.inc.php.
References DataObject\getData().
Referenced by getSupportedLocaleNames().
Context::getSupportedSubmissionLocaleNames | ( | ) |
Return associative array of all locales supported by submissions on the site. These locales are used to provide a language toggle on the main site pages.
Definition at line 246 of file Context.inc.php.
References PKPLocale\getAllLocales(), DataObject\getData(), and getSupportedSubmissionLocales().
Context::getSupportedSubmissionLocales | ( | ) |
Get the supported submission locales.
Definition at line 236 of file Context.inc.php.
References DataObject\getData().
Referenced by getSupportedSubmissionLocaleNames().
Context::getViews | ( | ) |
Get context main page views.
Definition at line 432 of file Context.inc.php.
References $application, PKPApplication\get(), Application\getContextAssocType(), and DataObject\getId().
Context::setContactEmail | ( | $contactEmail | ) |
Set the contact email for this context
$contactEmail | string |
Definition at line 77 of file Context.inc.php.
References DataObject\setData().
Context::setContactName | ( | $contactName | ) |
Set the contact name for this context
$contactName | string |
Definition at line 61 of file Context.inc.php.
References DataObject\setData().
Context::setDescription | ( | $description, | |
$locale = null |
|||
) |
Set context description.
$description | string |
$locale | string optional |
Definition at line 95 of file Context.inc.php.
References DataObject\setData().
Context::setEnabled | ( | $enabled | ) |
Set enabled flag of context
$enabled | int |
Definition at line 127 of file Context.inc.php.
References DataObject\setData().
Context::setName | ( | $name, | |
$locale = null |
|||
) |
Set the name of the context
$name | string |
Definition at line 38 of file Context.inc.php.
References DataObject\setData().
Context::setPath | ( | $path | ) |
Set path to context (in URL).
$path | string |
Definition at line 111 of file Context.inc.php.
References DataObject\setData().
Context::setPrimaryLocale | ( | $primaryLocale | ) |
Set the primary locale of this context.
$locale | string |
Definition at line 143 of file Context.inc.php.
References DataObject\setData().
Context::setSequence | ( | $sequence | ) |
Set sequence of context in site table of contents.
$sequence | float |
Definition at line 158 of file Context.inc.php.
References DataObject\setData().
Context::updateSetting | ( | $name, | |
$value, | |||
$type = null , |
|||
$isLocalized = false |
|||
) |
Update a context setting value.
$name | string |
$value | mixed |
$type | string optional |
$isLocalized | boolean optional |
Definition at line 423 of file Context.inc.php.
References DataObject\getId().