ocs  2.3.6
About: OCS (Open Conference System) is a Web publishing tool that will create a complete Web presence for your scholarly conference.
  Fossies Dox: ocs-2.3.6.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

AppLocale Class Reference
Inheritance diagram for AppLocale:
[legend]
Collaboration diagram for AppLocale:
[legend]

Public Member Functions

 getSupportedLocales ()
 
 getSupportedFormLocales ()
 
 getLocale ()
 
 getLocalePrecedence ()
 
 getPrimaryLocale ()
 
 makeComponentMap ($locale)
 
- Public Member Functions inherited from PKPLocale
getLocaleFiles ($locale=null)
 
 translate ($key, $params=array(), $locale=null)
 
 initialize ()
 
 getFilenameComponentMap ($locale)
 
 requireComponents ($components, $locale=null)
 
registerLocaleFile ($locale, $filename, $addToTop=false)
 
 getLocaleStyleSheet ($locale)
 
 isLocaleComplete ($locale)
 
 isLocaleValid ($locale)
 
_getAllLocalesCache ()
 
loadLocaleList ($filename)
 
 _allLocalesCacheMiss (&$cache, $id)
 
getAllLocales ()
 
 installLocale ($locale)
 
 uninstallLocale ($locale)
 
 reloadLocale ($locale)
 
 getParameterNames ($source)
 

Detailed Description

Definition at line 28 of file AppLocale.inc.php.

Member Function Documentation

◆ getLocale()

AppLocale::getLocale ( )

Return the key name of the user's currently selected locale (default is "en_US" for U.S. English).

Returns
string

Definition at line 72 of file AppLocale.inc.php.

References Request\getConference(), PKPRequest\getCookieVar(), SessionManager\getManager(), PKPRequest\getSite(), getSupportedLocales(), PKPRequest\getUserVar(), Config\getVar(), PKPLocale\isLocaleValid(), and LOCALE_DEFAULT.

Referenced by CurrencyDAO\_cacheMiss(), CurrencyDAO\_getCache(), CountryDAO\_getCountryCache(), DirectorSubmissionDAO\_getUnfilteredDirectorSubmissions(), TrackDirectorSubmissionDAO\_getUnfilteredTrackDirectorSubmissions(), AboutHandler\aboutThisPublishingSystem(), PKPPlugin\addHelpData(), PKPPlugin\addLocaleData(), MetadataDescription\addStatement(), TinyMCEPlugin\callback(), Form\display(), PayPalPlugin\displayPaymentForm(), EmailHandler\emails(), ControlledVocabDAO\enumerate(), EmailTemplateForm\execute(), PKPAnnouncementTypeDAO\getAnnouncementTypeName(), AuthorSubmissionDAO\getAuthorSubmission(), AuthorSubmissionDAO\getAuthorSubmissions(), PKPPageRouter\getCacheFilename(), ConferenceEventLogDAO\getConferenceLogEntriesByAssoc(), DirectorSubmissionDAO\getDirectorSubmission(), CountryDAO\getFilename(), Form\getFormLocale(), PaperGalley\getGalleyLabel(), AuthorSubmissionDAO\getIncompleteSubmissions(), PKPHelp\getLocale(), getLocalePrecedence(), Conference\getLocalizedFavicon(), PublishedPaper\getLocalizedGalleys(), Site\getLocalizedPageHeaderTitle(), Conference\getLocalizedSetting(), SchedConf\getLocalizedSetting(), Site\getLocalizedSetting(), ConferenceEventLogDAO\getLogEntry(), Conference\getPageHeaderLogo(), Conference\getPageHeaderTitle(), PaperDAO\getPaper(), PaperReportDAO\getPaperReport(), PaperDAO\getPapersBySchedConfId(), PaperDAO\getPapersByUserId(), PublishedPaperDAO\getPublishedPaperByPaperId(), PublishedPaperDAO\getPublishedPaperByPublicPaperId(), PublishedPaperDAO\getPublishedPaperIdsAlphabetizedByTitle(), PublishedPaperDAO\getPublishedPapers(), PublishedPaperDAO\getPublishedPapersBySchedConfId(), PublishedPaperDAO\getPublishedPapersByTrackId(), PublishedPaperDAO\getPublishedPapersInTracks(), RegistrantReportDAO\getRegistrantReport(), RegistrationOptionDAO\getRegistrationOptionName(), RegistrationTypeDAO\getRegistrationTypeName(), ReviewerSubmissionDAO\getReviewerSubmission(), ReviewerSubmissionDAO\getReviewerSubmissionsByReviewerId(), ReviewReportDAO\getReviewReport(), MetadataDescription\getStatement(), TrackDirectorSubmissionDAO\getTrackDirectorSubmission(), ImportOCS1\importConference(), ImportOCS1\importPapers(), ImportOCS1\importRegistrations(), ImportOCS1\importSchedConf(), ImportOCS1\importTracks(), AboutHandler\index(), EmailTemplateForm\initData(), InstallForm\initData(), PKPLocale\initialize(), SettingsDAO\installSettings(), SiteSettingsDAO\installSettings(), ConferenceSettingsDAO\installSettings(), NlmCitationSchemaCitationOutputFormatFilter\NlmCitationSchemaCitationOutputFormatFilter(), PKPMailTemplate\PKPMailTemplate(), PKPTemplateManager\PKPTemplateManager(), Installer\preInstall(), NlmCitationSchemaCitationOutputFormatFilter\process(), SchedConfHandler\program(), CustomLocalePlugin\register(), PKPLocale\requireComponents(), ConferenceRTAdmin\restoreVersions(), TrackDirectorAction\setEditingFile(), SubmitHandler\submitUploadSuppFile(), OAIMetadataFormat_DC\toXml(), PKPLocale\translate(), SubmissionEditHandler\uploadSuppFile(), LDAPAuthPlugin\userFromAttr(), and HelpHandler\view().

◆ getLocalePrecedence()

AppLocale::getLocalePrecedence ( )

Get the stack of "important" locales, most important first.

Returns
array

Definition at line 131 of file AppLocale.inc.php.

References Request\getConference(), getLocale(), and PKPRequest\getSite().

Referenced by DataObject\getLocalizedData().

◆ getPrimaryLocale()

AppLocale::getPrimaryLocale ( )

Retrieve the primary locale of the current context.

Returns
string

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

References Request\getConference(), PKPRequest\getSite(), PKPLocale\isLocaleValid(), and LOCALE_DEFAULT.

Referenced by DirectorSubmissionDAO\_getUnfilteredDirectorSubmissions(), TrackDirectorSubmissionDAO\_getUnfilteredTrackDirectorSubmissions(), AboutHandler\aboutThisPublishingSystem(), Form\display(), ControlledVocabDAO\enumerate(), PKPAnnouncementTypeDAO\getAnnouncementTypeName(), AuthorSubmissionDAO\getAuthorSubmission(), AuthorSubmissionDAO\getAuthorSubmissions(), ConferenceEventLogDAO\getConferenceLogEntriesByAssoc(), DirectorSubmissionDAO\getDirectorSubmission(), PKPEmailTemplateDAO\getEmailTemplate(), FormValidatorLocale\getFieldValue(), AuthorSubmissionDAO\getIncompleteSubmissions(), Conference\getLocalizedFavicon(), PublishedPaper\getLocalizedGalleys(), Site\getLocalizedPageHeaderTitle(), Conference\getLocalizedSetting(), SchedConf\getLocalizedSetting(), Site\getLocalizedSetting(), ConferenceEventLogDAO\getLogEntry(), FormValidatorLocale\getMessage(), Conference\getPageHeaderLogo(), Conference\getPageHeaderTitle(), PaperDAO\getPaper(), PaperReportDAO\getPaperReport(), PaperDAO\getPapersBySchedConfId(), PaperDAO\getPapersByUserId(), PublishedPaperDAO\getPublishedPaperByPaperId(), PublishedPaperDAO\getPublishedPaperByPublicPaperId(), PublishedPaperDAO\getPublishedPaperIdsAlphabetizedByTitle(), PublishedPaperDAO\getPublishedPapers(), PublishedPaperDAO\getPublishedPapersBySchedConfId(), PublishedPaperDAO\getPublishedPapersByTrackId(), PublishedPaperDAO\getPublishedPapersInTracks(), RegistrantReportDAO\getRegistrantReport(), RegistrationOptionDAO\getRegistrationOptionName(), RegistrationTypeDAO\getRegistrationTypeName(), ReviewerSubmissionDAO\getReviewerSubmission(), ReviewerSubmissionDAO\getReviewerSubmissionsByReviewerId(), ReviewReportDAO\getReviewReport(), TrackDirectorSubmissionDAO\getTrackDirectorSubmission(), AboutHandler\index(), NotificationHandler\notificationFeed(), UserXMLParser\parseData(), and SchedConfSetupStep2Form\validate().

◆ getSupportedFormLocales()

AppLocale::getSupportedFormLocales ( )

Get all supported form locales for the current context.

Returns
array

Definition at line 52 of file AppLocale.inc.php.

References PKPLocale\getAllLocales(), Request\getConference(), PKPRequest\getSite(), and Config\getVar().

Referenced by Form\display().

◆ getSupportedLocales()

AppLocale::getSupportedLocales ( )

Get all supported UI locales for the current context.

Returns
array

Definition at line 33 of file AppLocale.inc.php.

References PKPLocale\getAllLocales(), Request\getConference(), PKPRequest\getSite(), and Config\getVar().

Referenced by getLocale().

◆ makeComponentMap()

AppLocale::makeComponentMap (   $locale)

Make a map of components to their respective files.

Parameters
$localestring
Returns
array

Reimplemented from PKPLocale.

Definition at line 173 of file AppLocale.inc.php.

References LOCALE_COMPONENT_APPLICATION_COMMON, LOCALE_COMPONENT_OCS_ADMIN, LOCALE_COMPONENT_OCS_AUTHOR, LOCALE_COMPONENT_OCS_DEFAULT, LOCALE_COMPONENT_OCS_DIRECTOR, and LOCALE_COMPONENT_OCS_MANAGER.

Referenced by PKPLocale\getFilenameComponentMap(), and CustomLocaleAction\getLocaleFiles().


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