ENH Add localization support (#119)

silverstripe · Nov 14, 2023 · 64f5829 · 64f5829
1 parent 369b619
commit 64f5829
Show file tree

Hide file tree

Showing 18 changed files with 254 additions and 198 deletions.
diff --git a/client/dist/js/bundle.js b/client/dist/js/bundle.js
diff --git a/client/lang/en.js b/client/lang/en.js
@@ -6,74 +6,10 @@ if (typeof(ss) === 'undefined' || typeof(ss.i18n) === 'undefined') {
   }
 } else {
   ss.i18n.addDictionary('en', {
-    "AssetAdmin.ADD_FOLDER_BUTTON": "Add folder",
-    "AssetAdmin.BACK": "Back",
-    "AssetAdmin.BACK_DESCRIPTION": "Navigate up a level",
-    "AssetAdmin.BULK_ACTIONS_CONFIRM": "Are you sure you want to %s these files?",
-    "AssetAdmin.BULK_ACTIONS_DELETE": "Delete",
-    "AssetAdmin.BULK_ACTIONS_DELETE_CONFIRM": "Are you sure you want to delete these files?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_FAIL": "%s folders/files were successfully archived, but %s files were not able to be archived.",
-    "AssetAdmin.BULK_ACTIONS_DELETE_FOLDER": "These folders contain files which are currently in use, you must move or delete their contents before you can delete the folder.",
-    "AssetAdmin.BULK_ACTIONS_DELETE_MULTI_CONFIRM": "There are %s files currently in use, are you sure you want to delete these files?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SINGLE_CONFIRM": "This file is currently in use in %s places, are you sure you want to delete it?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SUCCESS": "%s folders/files were successfully archived.",
-    "AssetAdmin.BULK_ACTIONS_PLACEHOLDER": "Select an action...",
-    "AssetAdmin.CANCEL": "Cancel",
-    "AssetAdmin.CONFIRMDELETE": "Are you sure you want to delete this record?",
-    "AssetAdmin.CREATED": "First uploaded",
-    "AssetAdmin.DELETE": "Delete",
-    "AssetAdmin.DIM": "Dimensions",
-    "AssetAdmin.DROPZONE_CANCEL_UPLOAD": "Cancel upload",
-    "AssetAdmin.DROPZONE_CANCEL_UPLOAD_CONFIRMATION": "Are you sure you want to cancel this upload?",
-    "AssetAdmin.DROPZONE_DEFAULT_MESSAGE": "Drop files here to upload",
-    "AssetAdmin.DROPZONE_FAILED_UPLOAD": "Failed to upload file",
-    "AssetAdmin.DROPZONE_FALLBACK_MESSAGE": "Your browser does not support drag'n'drop file uploads.",
-    "AssetAdmin.DROPZONE_FALLBACK_TEXT": "Please use the fallback form below to upload your files like in the olden days.",
-    "AssetAdmin.DROPZONE_FILE_TOO_BIG": "File is too big. Max filesize: %sMiB.",
-    "AssetAdmin.DROPZONE_INVALID_FILE_TYPE": "You can't upload files of this type.",
-    "AssetAdmin.DROPZONE_MAX_FILES_EXCEEDED": "You can not upload any more files.",
-    "AssetAdmin.DROPZONE_REMOVE_FILE": "Remove file",
-    "AssetAdmin.DROPZONE_RESPONSE_ERROR": "Server responded with an error.",
-    "AssetAdmin.DROPZONE_SUCCESS_UPLOAD": "File uploaded",
-    "AssetAdmin.DROPZONE_UPLOAD": "Upload",
-    "AssetAdmin.EDIT": "Edit",
-    "AssetAdmin.FILENAME": "Filename",
-    "AssetAdmin.FILES": "Files",
-    "AssetAdmin.FILE_MISSING": "File cannot be found",
-    "AssetAdmin.FILTER_DATE_ASC": "oldest",
-    "AssetAdmin.FILTER_DATE_DESC": "newest",
-    "AssetAdmin.FILTER_TITLE_ASC": "title a-z",
-    "AssetAdmin.FILTER_TITLE_DESC": "title z-a",
-    "AssetAdmin.JOIN": ",",
-    "AssetAdmin.JOINLAST": "and",
-    "AssetAdmin.LASTEDIT": "Last changed",
-    "AssetAdmin.LOADMORE": "Load more",
-    "AssetAdmin.NOITEMSFOUND": "No items found",
-    "AssetAdmin.PROMPTFOLDERNAME": "Please enter a folder name (or blank to cancel)",
-    "AssetAdmin.REPlACE_FILE_SUCCESS": "Upload successful, the file will be replaced when you Save.",
-    "AssetAdmin.SAVE": "Save",
-    "AssetAdmin.SEARCHCLEARRESULTS": "Clear search",
-    "AssetAdmin.SEARCHRESULTS": "Search results",
-    "AssetAdmin.SEARCHRESULTSMESSAGE": "Search results {parts}",
-    "AssetAdmin.SEARCHRESULTSMESSAGECATEGORY": "categorised as '{appCategory}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDBETWEEN": "last edited between '{lastEditedFrom}' and '{lastEditedTo}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDFROM": "last edited from '{lastEditedFrom}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDTO": "last edited before '{lastEditedTo}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEKEYWORDS": "with keywords '{name}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGELIMIT": "limited to the folder '{folder}'",
-    "AssetAdmin.SELECT": "Select",
-    "AssetAdmin.SIZE": "Size",
-    "AssetAdmin.TITLE": "Title",
-    "AssetAdmin.TYPE": "File type",
-    "AssetAdmin.URL": "URL",
-    "AssetAdmin.ADD_FILES": "Add from files",
-    "AssetAdmin.BROWSE": "Browse",
-    "AssetAdmin.EMPTY": "No files",
-    "AssetAdmin.OR": "or",
-    "AssetAdmin.ERROR_OEMBED_REMOTE": "Embed is only compatible with remote files",
-    "AssetAdmin.CreateTitle": "Insert new media from the web",
-    "AssetAdmin.EditTitle": "Media from the web",
-    "AssetAdmin.NEXT": "Next",
-    "AssetAdmin.PREVIOUS": "Previous"
-});
+    "LinkField.SAVE_SUCCESS": "Saved link",
+    "LinkField.CONFIRM_DELETE": "Deleted link",
+    "LinkField.DELETE_ERROR": "Failed to delete link",
+    "LinkField.ADD_LINK": "Add Link",
+    "LinkField.CLEAR": "Clear"
+  });
 }
diff --git a/client/lang/src/en.json b/client/lang/src/en.json
@@ -1,75 +1,7 @@
 {
-    "AssetAdmin.ADD_FOLDER_BUTTON": "Add folder",
-    "AssetAdmin.BACK": "Back",
-    "AssetAdmin.BACK_DESCRIPTION": "Navigate up a level",
-    "AssetAdmin.BULK_ACTIONS_CONFIRM": "Are you sure you want to %s these files?",
-    "AssetAdmin.BULK_ACTIONS_DELETE": "Delete",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SINGLE_ITEM_CONFIRM": "Are you sure you want to delete this file/folder?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_MULTIPLE_ITEMS_CONFIRM": "Are you sure you want to delete these files/folders?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_MULTIPLE_ITEMS_IN_USE_CONFIRM": "%s item(s) are currently in use in %s place(s). Are you sure you want to delete them?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SINGLE_FILE_IN_USE_CONFIRM": "This file is currently in use in %s place(s). Are you sure you want to delete it?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_MULTIPLE_FILES_IN_USE_CONFIRM": "%s of these files are currently used in %s place(s). Are you sure you want to delete them?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SINGLE_FOLDER_IN_USE_CONFIRM": "This folder contains file(s) that are currently used in %s place(s). Are you sure you want to delete it?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_MULTIPLE_FOLDERS_IN_USE_CONFIRM": "%s of these folders contain file(s) that are currently used in %s place(s). Are you sure you want to delete them?",
-    "AssetAdmin.BULK_ACTIONS_DELETE_WARNING": "Ensure files are removed from content areas prior to deleting them, otherwise they will appear as broken links.",
-    "AssetAdmin.BULK_ACTIONS_DELETE_FAIL": "%s folders/files were successfully archived, but %s files were not able to be archived.",
-    "AssetAdmin.BULK_ACTIONS_DELETE_SUCCESS": "%s folders/files were successfully archived.",
-    "AssetAdmin.BULK_ACTIONS_PLACEHOLDER": "Select an action...",
-    "AssetAdmin.CANCEL": "Cancel",
-    "AssetAdmin.CONFIRMDELETE": "Are you sure you want to delete this record?",
-    "AssetAdmin.CREATED": "First uploaded",
-    "AssetAdmin.DELETE": "Delete",
-    "AssetAdmin.DIM": "Dimensions",
-    "AssetAdmin.DROPZONE_CANCEL_UPLOAD": "Cancel upload",
-    "AssetAdmin.DROPZONE_CANCEL_UPLOAD_CONFIRMATION": "Are you sure you want to cancel this upload?",
-    "AssetAdmin.DROPZONE_DEFAULT_MESSAGE": "Drop files here to upload",
-    "AssetAdmin.DROPZONE_FAILED_UPLOAD": "Failed to upload file",
-    "AssetAdmin.DROPZONE_FALLBACK_MESSAGE": "Your browser does not support drag'n'drop file uploads.",
-    "AssetAdmin.DROPZONE_FALLBACK_TEXT": "Please use the fallback form below to upload your files like in the olden days.",
-    "AssetAdmin.DROPZONE_FILE_TOO_BIG": "File is too big. Max filesize: %sMiB.",
-    "AssetAdmin.DROPZONE_INVALID_FILE_TYPE": "You can't upload files of this type.",
-    "AssetAdmin.DROPZONE_MAX_FILES_EXCEEDED": "You can not upload any more files.",
-    "AssetAdmin.DROPZONE_REMOVE_FILE": "Remove file",
-    "AssetAdmin.DROPZONE_RESPONSE_ERROR": "Server responded with an error.",
-    "AssetAdmin.DROPZONE_SUCCESS_UPLOAD": "File uploaded",
-    "AssetAdmin.DROPZONE_UPLOAD": "Upload",
-    "AssetAdmin.EDIT": "Edit",
-    "AssetAdmin.FILENAME": "Filename",
-    "AssetAdmin.FILES": "Files",
-    "AssetAdmin.FILE_MISSING": "File cannot be found",
-    "AssetAdmin.FILTER_DATE_ASC": "oldest",
-    "AssetAdmin.FILTER_DATE_DESC": "newest",
-    "AssetAdmin.FILTER_TITLE_ASC": "title a-z",
-    "AssetAdmin.FILTER_TITLE_DESC": "title z-a",
-    "AssetAdmin.JOIN": ",",
-    "AssetAdmin.JOINLAST": "and",
-    "AssetAdmin.LASTEDIT": "Last changed",
-    "AssetAdmin.LOADMORE": "Load more",
-    "AssetAdmin.NOITEMSFOUND": "No items found",
-    "AssetAdmin.PROMPTFOLDERNAME": "Please enter a folder name (or blank to cancel)",
-    "AssetAdmin.REPlACE_FILE_SUCCESS": "Upload successful, the file will be replaced when you Save.",
-    "AssetAdmin.SAVE": "Save",
-    "AssetAdmin.SEARCHCLEARRESULTS": "Clear search",
-    "AssetAdmin.SEARCHRESULTS": "Search results",
-    "AssetAdmin.SEARCHRESULTSMESSAGE": "Search results {parts}",
-    "AssetAdmin.SEARCHRESULTSMESSAGECATEGORY": "categorised as '{appCategory}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDBETWEEN": "last edited between '{lastEditedFrom}' and '{lastEditedTo}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDFROM": "last edited from '{lastEditedFrom}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEEDITEDTO": "last edited before '{lastEditedTo}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGEKEYWORDS": "with keywords '{name}'",
-    "AssetAdmin.SEARCHRESULTSMESSAGELIMIT": "limited to the folder '{folder}'",
-    "AssetAdmin.SELECT": "Select",
-    "AssetAdmin.SIZE": "Size",
-    "AssetAdmin.TITLE": "Title",
-    "AssetAdmin.TYPE": "File type",
-    "AssetAdmin.URL": "URL",
-    "AssetAdmin.ADD_FILES": "Add from files",
-    "AssetAdmin.BROWSE": "Browse",
-    "AssetAdmin.EMPTY": "No files",
-    "AssetAdmin.OR": "or",
-    "AssetAdmin.ERROR_OEMBED_REMOTE": "Embed is only compatible with remote files",
-    "AssetAdmin.CreateTitle": "Insert new media from the web",
-    "AssetAdmin.EditTitle": "Media from the web",
-    "AssetAdmin.NEXT": "Next",
-    "AssetAdmin.PREVIOUS": "Previous"
+    "LinkField.SAVE_SUCCESS": "Saved link",
+    "LinkField.CONFIRM_DELETE": "Deleted link",
+    "LinkField.DELETE_ERROR": "Failed to delete link",
+    "LinkField.ADD_LINK": "Add Link",
+    "LinkField.CLEAR": "Clear"
 }
diff --git a/client/src/boot/registerComponents.js b/client/src/boot/registerComponents.js
@@ -1,4 +1,3 @@
-
 /* eslint-disable */
 import Injector from 'lib/Injector';
 import LinkPicker from 'components/LinkPicker/LinkPicker';

diff --git a/client/src/components/LinkField/LinkField.js b/client/src/components/LinkField/LinkField.js
@@ -1,3 +1,4 @@
+/* eslint-disable */
 import React, { useState, useEffect } from 'react';
 import { bindActionCreators, compose } from 'redux';
 import { connect } from 'react-redux';
@@ -8,6 +9,7 @@ import * as toastsActions from 'state/toasts/ToastsActions';
 import backend from 'lib/Backend';
 import Config from 'lib/Config';
 import PropTypes from 'prop-types';
+import i18n from 'i18n';
 
 // section used in window.ss config
 const section = 'SilverStripe\\LinkField\\Controllers\\LinkFieldController';
@@ -49,7 +51,12 @@ const LinkField = ({ value, onChange, types, actions }) => {
       onChange(valueFromSchemaResponse);
 
       // success toast
-      actions.toasts.success('Saved link');
+      actions.toasts.success(
+        i18n._t(
+          'LinkField.SAVE_SUCCESS',
+          'Saved link',
+        )
+      );
     }
 
     return Promise.resolve();
@@ -63,10 +70,20 @@ const LinkField = ({ value, onChange, types, actions }) => {
     // CSRF token 'X-SecurityID' headers needs to be present for destructive requests
     backend.delete(endpoint, {}, { 'X-SecurityID': Config.get('SecurityID') })
       .then(() => {
-        actions.toasts.success('Deleted link');
+        actions.toasts.success(
+          i18n._t(
+            'LinkField.DELETE_SUCCESS',
+            'Deleted link',
+          )
+        );
       })
       .catch(() => {
-        actions.toasts.error('Failed to delete link');
+        actions.toasts.error(
+          i18n._t(
+            'LinkField.DELETE_ERROR',
+            'Failed to delete link',
+          )
+        );
       });
 
     // update component state

diff --git a/client/src/components/LinkPicker/LinkPickerMenu.js b/client/src/components/LinkPicker/LinkPickerMenu.js
@@ -15,7 +15,7 @@ const LinkPickerMenu = ({ types, onSelect }) => {
       toggle={toggle}
       className="link-picker__menu"
     >
-      <DropdownToggle className="link-picker__menu-toggle font-icon-link" caret>{i18n._t('Link.ADD_LINK', 'Add Link')}</DropdownToggle>
+      <DropdownToggle className="link-picker__menu-toggle font-icon-link" caret>{i18n._t('LinkField.ADD_LINK', 'Add Link')}</DropdownToggle>
       <DropdownMenu>
         {types.map(({key, title}) =>
             <DropdownItem key={key} onClick={() => onSelect(key)}>{title}</DropdownItem>

diff --git a/client/src/components/LinkPicker/LinkPickerTitle.js b/client/src/components/LinkPicker/LinkPickerTitle.js
@@ -23,7 +23,7 @@ const LinkPickerTitle = ({ title, description, typeTitle, onClear, onClick }) =>
       </small>
       </div>
     </Button>
-    <Button className="link-picker__clear" color="link" onClick={stopPropagation(onClear)}>{i18n._t('Link.CLEAR', 'Clear')}</Button>
+    <Button className="link-picker__clear" color="link" onClick={stopPropagation(onClear)}>{i18n._t('LinkField.CLEAR', 'Clear')}</Button>
   </div>
 );
 

diff --git a/lang/en.yml b/lang/en.yml
@@ -0,0 +1,34 @@
+en:
+  LinkField:
+    ANCHOR_DESCRIPTION: 'Do not prepend "#". Anchor suggestions will be displayed once the linked page is attached.'
+    ANCHOR_FIELD_TITLE: 'Anchor'
+    BAD_DATA: 'Bad data'
+    CREATE_LINK: 'Create link'
+    DATA_HAS_NO_TYPEKEY: '"{class}": $data does not have a typeKey.'
+    EMPTY_DATA: 'Empty data'
+    EXTERNAL_URL_FIELD: 'External url'
+    EMAIL_FIELD: 'Email address'
+    FILE_FIELD: 'File'
+    INVALID_DATA_TO_ARRAY: '"{class}": Could not convert $data to an array.'
+    INVALID_ID': 'Invalid ID'
+    INVALID_JSON: '"{class}": Decoding json string failred with "{error}"'
+    INVALID_TOKEN: 'Invalid CSRF token'
+    INVALID_TYPEKEY: 'Invalid typeKey'
+    INVALID_TYPENAME: '"{class}": {typename} is not a valid link type'
+    KEYS_ARE_NOT_ARRAY: 'If `keys` is provdied, it must be an array'
+    LINK_TYPE_TITLE: 'Link Type'
+    LINK_FIELD_TITLE: 'Title'
+    NO_CLASSNAME: '"{class}": All types should reference a valid classname'
+    NOT_REGISTERED_LINKTYPE: '"{class}": "{typekey}" is not a registered Link Type.'
+    NOTHING_TO_PROCESS: "Nothing to process for `{table}`\r\n"
+    OPEN_IN_NEW_TITLE: 'Open in new window?'
+    PAGE_FIELD_TITLE: 'Page'
+    PHONE_FIELD: 'Phone'
+    PROCESSING_TABLE: "Processing `{table}`\r\n"
+    QUERY_FIELD_TITLE: 'Query string'
+    QUERY_STRING_DESCRIPTION: 'Do not prepend "?". EG: "option1=value&option2=value2"'
+    RECORDS_INSERTED: "{numrecords} records inserted, finished processing `{table}`\r\n"
+    TITLE_DESCRIPTION: 'Auto generated from Page title if left blank'
+    UNAUTHORIZED: 'Unauthorized'
+    UPDATE_LINK: 'Update link'
+    VERSIONED_STATUS_MISMATCH: 'Linkable and LinkField do not have matching Versioned applications. Make sure that both are either un-Versioned or Versioned'