Download the PHP package 26b/i18n-midoru without Composer
On this page you can find all versions of the php package 26b/i18n-midoru. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 26b/i18n-midoru
More information about 26b/i18n-midoru
Files in 26b/i18n-midoru
Package i18n-midoru
Short Description Handle translation operation with ease (download and upload).
License MIT
Informations about the package i18n-midoru
Translation Helper
This library has some helper functions/classes for dealing with exporting and importing translations based on a config file. Right now we're only supporting Localise as the source for translations.
⚠️ This library is in active development so the API may suffer changes.
How to use?
There are essentially three interfaces, they only differ on how they ingest the options to the Translations system.
-
Use a JSON file with all the configuration.
-
Use PHP as your interface and have a PHP data structure with the configuration.
-
Use a custom command and fetch config from the options passed to it.
Create your two command files in PHP.
Now you can run them from the command line like this:
Options
Regardless of the method to pass information to the Translations
class, you can use any of the following options to configure what you want to happen.
Export (export)
locale
string
|array
- Short code(s) for the language(s) to export. See Locale Export API.
ext
string
- The extensions accepted by the Localise API. See Locale Export API.
format
string
- The format accepted by the Localise API. See Locale Export API.
domain
string
|optional
- Domain for the export. Appended in the beginning of the filename, before the locale. See below.
filename
string
|optional
- Filename for the export. Takes precedence over domain. See below.
js-handle
string
|optional
- To be append at the end of the filename with a '-' preceding it, before the extension. See below.
path
string
|optional
|default:
./- Path to the directory where the file will be saved.
wrap-jed
bool
|optional
|default:
true if format is JED- Specifies if the content in the exported JSON files should be wrapped by an array with key 'locale_data'.
name
string
|required
if using CLI- Name of the project.
The file path will be comprised of:
?(.*)
indicates optional values.
Import (import)
locale
string
|array
- Short code(s) for the language(s) to import. See Locale Import API.
ext
string
- The extensions accepted by the Localise API. See Locale Import API.
domain
string
|optional
- Domain for the import. Appended in the beginning of the filename, before the locale. See below.
filename
string
|optional
- Filename for the import. Takes precedence over domain. See below.
js-handle
string
|optional
- To be append at the end of the filename with a '-' preceding it, before the extension. See below.
path
string
|optional
|default:
./- Path to the directory where the file will be saved.
name
string
|required
if using CLI- Name of the project.
The file path will be comprised of:
?(.*)
indicates optional values.
Make pots (make_pots)
domain
string
- Domain for the
wp i18n make-pots
command.
source
string
- Source path for the
wp i18n make-pots
command. Directory where the strings to be translated will be extracted from.
destination
string
- Destination path for the
wp i18n make-pots
command. Where the pot file will be saved.
skip-js
:bool
|optional
|default:
true- Whether the option
--skip-js
will be passed to thewp i18n make-pots
command. Makes it so strings to be translated inside JS code will not be considered.
TODO
- Maybe rest of api params.
- Join all arguments and indicate which are not usable in some situations.