Open Journal Systems  3.3.0
AppLocale Class Reference
Inheritance diagram for AppLocale:
PKPLocale

Static Public Member Functions

static getLocale ()
 
static getLocalePrecedence ()
 
static getPrimaryLocale ()
 
static getSupportedFormLocales ()
 
static getSupportedLocales ()
 
static initialize ($request)
 
static makeComponentMap ($locale)
 
static registerLocaleFile ($locale, $filename, $addToTop=false)
 
static requireComponents ()
 
static setPrimaryLocale ($primaryLocale)
 
static setSupportedLocales ($supportedLocales)
 
static setTranslations ($translations)
 
static translate ($key, $params=array(), $locale=null, $missingKeyHandler=array())
 
- Static Public Member Functions inherited from PKPLocale
static _allLocalesCacheMiss ($cache, $id)
 
static & _getAllLocalesCache ()
 
static & _getAllLocalesCacheContent ()
 
static addOctothorpes ($key)
 
static get2LetterFrom3LetterIsoLanguage ($iso3Letter)
 
static get3LetterFrom2LetterIsoLanguage ($iso2Letter)
 
static get3LetterIsoFromLocale ($locale)
 
static & getAllLocales ()
 
static getFilenameComponentMap ($locale)
 
static getIso1FromIso3 ($iso3)
 
static getIso1FromLocale ($locale)
 
static getIso3FromIso1 ($iso1)
 
static getIso3FromLocale ($locale)
 
static getLocaleDirection ($locale)
 
static & getLocaleFiles ($locale=null)
 
static getLocaleFrom3LetterIso ($iso3Letter)
 
static getLocaleFromIso3 ($iso3)
 
static getLocaleStyleSheet ($locale)
 
static getParameterNames ($source)
 
static getTimeZone ()
 
static installLocale ($locale)
 
static isLocaleComplete ($locale)
 
static isLocaleValid ($locale)
 
static isLocaleWithFamilyFirst ($locale)
 
static & loadLocaleList ($filename)
 
static reloadLocale ($locale)
 
static uninstallLocale ($locale)
 

Static Public Attributes

static $primaryLocale = 'en_US'
 
static $supportedLocales = array('en_US' => 'English/America')
 
static $translations = array()
 
- Static Public Attributes inherited from PKPLocale
static $request
 

Detailed Description

Provides methods for loading locale data and translating strings identified by unique keys.

Mock implementation of the Locale class.

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

Member Function Documentation

◆ getLocale()

static AppLocale::getLocale ( )
static

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

Returns
string

Reimplemented from PKPLocale.

Definition at line 40 of file env1/MockAppLocale.inc.php.

Referenced by QuickSubmitForm\__construct(), MailTemplate\__construct(), Form\__construct(), MarkupConversionHelper\_addDependentImageToXmlDocument(), EditorialReportNotificationManager\_getLocalizedMonthName(), IssueHandler\_setupIssueTemplate(), UserGroupForm\_setUserGroupLocaleFields(), AboutSiteHandler\aboutThisPublishingSystem(), MarkupConversionHelper\addFileToSubmissionGalley(), ImmersionThemePlugin\addIssueTemplateData(), Plugin\addLocaleData(), MetadataDescription\addStatement(), MarkupConversionHelper\addXmlDocumentToSubmissionFileList(), SubmissionFilesGridDataProvider\applyFilter(), DublinCoreMetaPlugin\articleView(), MarkupBatchConversionHelper\buildSubmissionMetadataByContext(), UploadImageForm\deleteCoverImage(), IssueGridHandler\deleteCoverImage(), SubmissionChecklistGridHandler\deleteItem(), QuickSubmitForm\display(), ControlledVocabDAO\enumerate(), UploadImageForm\execute(), IssueForm\execute(), RegistrationForm\execute(), Dc11SchemaArticleAdapter\extractMetadataFromDataObject(), IssueForm\fetch(), SubmissionHandler\fetchChoices(), MarkupBatchConversionHandler\filesToConvert(), UserStageAssignmentDAO\filterUsersNotAssignedToStageInUserGroup(), AnnouncementTypeDAO\getAnnouncementTypeName(), AuthorDAO\getAuthorsAlphabetizedByJournal(), PKPPageRouter\getCacheFilename(), PKPApplication\getCCLicenseBadge(), PKP\components\forms\FormComponent\getConfig(), CustomBlockPlugin\getContents(), PKP\Services\PKPNavigationMenuService\getDisplayStatus(), UserDAO\getFetchParameters(), Identity\getFullName(), IssueGalley\getGalleyLabel(), ArticleGalley\getGalleyLabel(), Issue\getIssueIdentification(), DataObjectGridCellProvider\getLocale(), PKPLocale\getLocalePrecedence(), PKPAuthor\getLocalizedData(), PKPPublication\getLocalizedData(), Identity\getLocalizedData(), SubmissionFile\getLocalizedData(), Context\getLocalizedDateFormatLong(), Context\getLocalizedDateFormatShort(), Context\getLocalizedDateTimeFormatLong(), Context\getLocalizedDateTimeFormatShort(), Identity\getLocalizedFamilyName(), Context\getLocalizedFavicon(), Submission\getLocalizedGalleys(), Journal\getLocalizedPageHeaderLogo(), Journal\getLocalizedPageHeaderTitle(), Context\getLocalizedTimeFormat(), PKPVocabHandler\getMany(), PKPNotificationOperationManager\getParamsForCurrentLocale(), PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery(), ReviewerSubmissionDAO\getReviewerSubmission(), ReviewReportDAO\getReviewReport(), ArticleSearch\getSimilarityTerms(), MetadataDescription\getStatement(), SubscriptionTypeDAO\getSubscriptionTypeName(), EventLogEntry\getTranslatedMessage(), HelpHandler\index(), BootstrapThreeThemePlugin\init(), HealthSciencesThemePlugin\init(), UploadImageForm\initData(), IssueForm\initData(), InstallForm\initData(), PKPSubmissionSubmitStep1Form\initData(), GenreGridHandler\initialize(), CategoryCategoryGridHandler\initialize(), PKPTemplateManager\initialize(), PKPLocale\initialize(), SettingsDAO\installSettings(), SubmissionChecklistGridHandler\loadData(), Installer\preInstall(), TemplateBasedFilter\process(), TinyMCEPlugin\registerJS(), PKPTemplateManager\registerJSLibrary(), PKPTemplateManager\registerJSLibraryData(), SubmissionChecklistGridHandler\setDataElementSequence(), PKP\Services\PKPNavigationMenuService\setNMITitleLocalized(), PKPTemplateManager\setupBackendPage(), GoogleScholarPlugin\submissionView(), PKP\Services\PKPNavigationMenuService\transformNavMenuItemTitle(), PKPLocale\translate(), and LDAPAuthPlugin\userFromAttr().

◆ getLocalePrecedence()

static AppLocale::getLocalePrecedence ( )
static

Mocked method

Returns
array a test array of locales

Reimplemented from PKPLocale.

Definition at line 64 of file env1/MockAppLocale.inc.php.

Referenced by DataObject\getLocalizedData().

◆ getPrimaryLocale()

◆ getSupportedFormLocales()

◆ getSupportedLocales()

◆ initialize()

static AppLocale::initialize (   $request)
static

Initialize the locale system.

Parameters
$requestPKPRequest

Reimplemented from PKPLocale.

Definition at line 31 of file env1/MockAppLocale.inc.php.

Referenced by CommandLineTool\__construct(), and Dispatcher\dispatch().

◆ makeComponentMap()

static AppLocale::makeComponentMap (   $locale)
static

Make a map of components to their respective files.

Parameters
$localestring
Returns
array

Reimplemented from PKPLocale.

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

◆ registerLocaleFile()

static AppLocale::registerLocaleFile (   $locale,
  $filename,
  $addToTop = false 
)
static

Register a locale file against the current list.

Parameters
$localestring Locale key
$filenamestring Filename to new locale XML file
$addToTopboolean Whether to add to the top of the list (true) or the bottom (false). Allows overriding.

Reimplemented from PKPLocale.

Definition at line 48 of file env1/MockAppLocale.inc.php.

Referenced by Plugin\addLocaleData(), PKPLocale\initialize(), Plugin\installEmailTemplates(), and Plugin\installLocale().

◆ requireComponents()

static AppLocale::requireComponents ( )
static

method required during setup of the PKP templating engine and application framework

Reimplemented from PKPLocale.

Definition at line 56 of file env1/MockAppLocale.inc.php.

Referenced by AboutContextHandler\__construct(), HelpHandler\__construct(), AboutSiteHandler\__construct(), ReviewReminderForm\__construct(), SectionForm\__construct(), PKPManageFileApiHandler\__construct(), SubmissionLibraryLinkAction\__construct(), NotifyLinkAction\__construct(), InitiateExternalReviewForm\__construct(), PaymentTypesForm\__construct(), SubmissionFilesArtworkMetadataForm\__construct(), SupplementaryFileMetadataForm\__construct(), PromoteForm\__construct(), IssueGalleyForm\__construct(), UpgradeTool\__construct(), CopyAccessLogFileTool\__construct(), UserAccessibleWorkflowStageRequiredPolicy\__construct(), UserAccessibleWorkflowStagePolicy\__construct(), UserGroupForm\__construct(), SubmissionFilesUploadForm\__construct(), ArticleGalleyForm\__construct(), SubmissionFilesMetadataForm\__construct(), PKPSectionForm\__construct(), StageRolePolicy\__construct(), ScheduledTask\__construct(), PKPPublicIdentifiersForm\__construct(), SubscriptionPolicyForm\__construct(), PKP\components\PKPStatsComponent\__construct(), FileLoader\__construct(), ApiAuthorizationMiddleware\_authorize(), SubmissionFile\_generateName(), OAIMetadataFormat_JATS\_mungeMetadata(), RegistrationHandler\activateUser(), PKPSubmissionHandler\add(), AssignToIssueHandler\assign(), PKPUserHandler\authorizationDenied(), MarkupConversionHelper\buildSubmissionMetadata(), PLNPlugin\callbackLoadHandler(), ManagementHandler\context(), PKPInstall\createData(), DataciteXmlFilter\createSizesNode(), SectionGridHandler\deleteSection(), ArticleReportPlugin\display(), ReviewReportPlugin\display(), NativeImportExportPlugin\display(), ImportExportPlugin\displayXMLValidationErrors(), ManagementHandler\distribution(), PKPWorkflowHandler\editorDecisionActions(), installEmailTemplates\execute(), StatisticsReport\executeActions(), UserImportExportPlugin\executeCLI(), NativeImportExportPlugin\executeCLI(), PubObjectsExportPlugin\executeCLI(), Dc11SchemaArticleAdapter\extractMetadataFromDataObject(), RolesForm\fetch(), LibraryFileForm\fetch(), ResolverPlugin\fetch(), PKPNavigationMenuItemsForm\fetch(), SubmissionChecklistForm\fetch(), WebFeedGatewayPlugin\fetch(), GenreForm\fetch(), QueryForm\fetch(), AuthorDashboardTabHandler\fetchTab(), PKPToolsHandler\generateReport(), PKPSubmissionHandler\get(), PKP\components\listPanels\PKPSubmissionsListPanel\getConfig(), PKP\components\listPanels\PKPAnnouncementsListPanel\getConfig(), PKP\components\listPanels\PKPEmailTemplatesListPanel\getConfig(), User\getContactSignature(), Issue\getIssueIdentification(), PKP\Services\PKPSchemaService\getLocaleDefaults(), PKP\Services\PKPNavigationMenuService\getMenuItemTypes(), APP\Services\NavigationMenuService\getMenuItemTypesCallback(), PendingRevisionsNotificationManager\getNotificationContents(), PendingRevisionsNotificationManager\getNotificationMessage(), PKPNotificationManager\getNotificationMessage(), PKP\Services\PKPStatsEditorialService\getOverview(), ManualPaymentPlugin\getPaymentForm(), PKP\Services\PKPSubmissionService\getProperties(), StatisticsHelper\getReportObjectTypesArray(), ReviewAssignmentDAO\getReviewMethodsTranslationKeys(), PKP\Services\PKPUserService\getRolesOverview(), PKPPublication\getShortAuthorString(), PKPApplication\getWorkflowStageColor(), PKPApplication\getWorkflowStageName(), WorkflowStageDAO\getWorkflowStageTranslationKeys(), ManualPaymentPlugin\handle(), APIRouter\handleAuthorizationFailure(), PKPComponentRouter\handleAuthorizationFailure(), PKPEditorDecisionHandler\importPeerReviews(), PaymentsHandler\index(), InformationHandler\index(), ManageIssuesHandler\index(), DefaultThemePlugin\init(), ReviewerForm\initData(), RegistrationHandler\initialize(), ManagementHandler\initialize(), ReviewFormElementResponseItemListbuilderHandler\initialize(), NotificationsGridHandler\initialize(), SetupGridHandler\initialize(), SectionGridHandler\initialize(), LanguageGridHandler\initialize(), GenreGridHandler\initialize(), PluginGridHandler\initialize(), ReviewerReviewAttachmentsGridHandler\initialize(), SubmissionDocumentsFilesGridHandler\initialize(), PluginGalleryGridHandler\initialize(), ReviewFormGridHandler\initialize(), PaymentsGridHandler\initialize(), SubscriptionsGridHandler\initialize(), ExportableUsersGridHandler\initialize(), SubscriberSelectGridHandler\initialize(), SubscriptionTypesGridHandler\initialize(), UserSelectGridHandler\initialize(), ContextGridHandler\initialize(), PKPEditorDecisionHandler\initialize(), TocGridHandler\initialize(), UserGridHandler\initialize(), ExportPublishedSubmissionsListGridHandler\initialize(), PubIdExportIssuesListGridHandler\initialize(), PubIdExportRepresentationsListGridHandler\initialize(), AdminLanguageGridHandler\initialize(), AnnouncementTypeGridHandler\initialize(), ReviewFormElementsGridHandler\initialize(), CategoryCategoryGridHandler\initialize(), AdminHandler\initialize(), IssueGridHandler\initialize(), EditorialReportNotificationManager\initialize(), NavigationMenuItemsGridHandler\initialize(), NavigationMenusGridHandler\initialize(), ManageLanguageGridHandler\initialize(), LibraryFileGridHandler\initialize(), QueryNotesGridHandler\initialize(), PKPFileUploadWizardHandler\initialize(), IssueGalleyGridHandler\initialize(), StageParticipantGridHandler\initialize(), UserGroupGridHandler\initialize(), AuthorGridHandler\initialize(), ArticleGalleyGridHandler\initialize(), SubmissionEventLogGridHandler\initialize(), SubmissionFilesGridHandler\initialize(), PKPTemplateManager\initialize(), QueriesGridHandler\initialize(), SelectableSubmissionFileListCategoryGridHandler\initialize(), PKPReviewerGridHandler\initialize(), GridHandler\initialize(), Plugin\installData(), GenreDAO\installDefaults(), Installer\installEmailTemplate(), PKPLocale\installLocale(), GoogleAnalyticsPlugin\manage(), AnnouncementFeedPlugin\manage(), WebFeedPlugin\manage(), PLNPlugin\manage(), NavigationMenuItemHandler\preview(), PKPStatsHandler\publications(), PublishHandler\publish(), PKPSubmissionHandler\publishPublication(), OJSInstallTool\readParams(), ArticleSearchIndex\rebuildIndex(), EditorAction\recordDecision(), PdfJsViewerPlugin\register(), QuickSubmitPlugin\register(), PubObjectsExportPlugin\register(), PKPToolsHandler\reportGenerator(), PKP\Services\PKPContextService\restoreLocaleDefaults(), ReviewerGridHandler\reviewRead(), APIRouter\route(), PKPNotificationOperationManager\sendNotificationEmail(), SubscriptionExpiryReminder\sendReminder(), ReviewReminder\sendReminder(), PKP\Services\PKPNavigationMenuService\setAllNMILocalisedTitles(), PKP\Services\PKPSchemaService\setDefaults(), PKP\Services\PKPNavigationMenuService\setNMITitleLocalized(), PKPTemplateManager\setupBackendPage(), PKPToolsHandler\setupTemplate(), PKPReviewRoundTabHandler\setupTemplate(), SubmissionHandler\setupTemplate(), UserHandler\setupTemplate(), PKPAuthorDashboardHandler\setupTemplate(), NotificationHandler\setupTemplate(), PKPCatalogHandler\setupTemplate(), InstallHandler\setupTemplate(), ReportGeneratorHandler\setupTemplate(), PKPWorkflowTabHandler\setupTemplate(), InformationCenterHandler\setupTemplate(), PKPReviewerHandler\setupTemplate(), DashboardHandler\setupTemplate(), PKPSubmissionHandler\setupTemplate(), IssueHandler\setupTemplate(), LoginHandler\setupTemplate(), PKPHandler\setupTemplate(), ArticleHandler\setupTemplate(), PKPWorkflowHandler\setupTemplate(), AboutContextHandler\submissions(), PKPReviewerReviewStep1Form\validate(), PKP\Services\PKPSiteService\validate(), PKP\Services\PKPAnnouncementService\validate(), PKP\Services\PKPEmailTemplateService\validate(), PKP\Services\PKPContextService\validate(), PKP\Services\PKPPublicationService\validate(), APP\Services\PublicationService\validatePublication(), StaticPagesHandler\view(), NavigationMenuItemHandler\view(), and ManagementHandler\workflow().

◆ setPrimaryLocale()

static AppLocale::setPrimaryLocale (   $primaryLocale)
static

Setter to configure a custom primary locale for testing.

Parameters
$primaryLocalestring

Definition at line 87 of file env1/MockAppLocale.inc.php.

References $primaryLocale.

Referenced by PKPLocaleTest\testGetLocaleFrom3LetterIso().

◆ setSupportedLocales()

static AppLocale::setSupportedLocales (   $supportedLocales)
static

Setter to configure a custom primary locale for testing.

Parameters
$supportedLocalesarray example array( 'en_US' => 'English', 'de_DE' => 'German' )

Definition at line 108 of file env1/MockAppLocale.inc.php.

References $supportedLocales.

Referenced by PKPLocaleTest\testGetLocaleFrom3LetterIso().

◆ setTranslations()

static AppLocale::setTranslations (   $translations)
static

Set translation keys to be faked.

Parameters
$translationsarray

Definition at line 132 of file env1/MockAppLocale.inc.php.

References $translations.

◆ translate()

static AppLocale::translate (   $key,
  $params = array(),
  $locale = null,
  $missingKeyHandler = array() 
)
static

Mocked method

Parameters
$keystring
$paramsarray named substitution parameters
$localestring the locale to use
Returns
string

Reimplemented from PKPLocale.

Definition at line 75 of file env1/MockAppLocale.inc.php.

Field Documentation

◆ $primaryLocale

AppLocale::$primaryLocale = 'en_US'
static

Definition at line 23 of file env1/MockAppLocale.inc.php.

Referenced by getPrimaryLocale(), and setPrimaryLocale().

◆ $supportedLocales

AppLocale::$supportedLocales = array('en_US' => 'English/America')
static

Definition at line 24 of file env1/MockAppLocale.inc.php.

Referenced by getSupportedLocales(), and setSupportedLocales().

◆ $translations

AppLocale::$translations = array()
static

Definition at line 25 of file env1/MockAppLocale.inc.php.

Referenced by setTranslations().


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