Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cakephp/i18n
[READ-ONLY] Provides support for message translation and localization for dates and numbers. This repo is a split of the main code that can be found in https://github.com/cakephp/cakephp
https://github.com/cakephp/i18n
Last synced: about 1 month ago
JSON representation
[READ-ONLY] Provides support for message translation and localization for dates and numbers. This repo is a split of the main code that can be found in https://github.com/cakephp/cakephp
- Host: GitHub
- URL: https://github.com/cakephp/i18n
- Owner: cakephp
- License: other
- Created: 2015-01-13T13:37:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T02:55:14.000Z (2 months ago)
- Last Synced: 2024-10-26T13:44:40.455Z (about 2 months ago)
- Language: PHP
- Size: 640 KB
- Stars: 29
- Watchers: 29
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-php - CakePHP I18n - Message translation and localization for dates and numbers. (Table of Contents / Internationalisation and Localisation)
- awesome-php-cn - CakePHP I18n - 消息翻译和本地化的日期和数字. (目录 / 国际化和本土化 Internationalisation and Localisation)
- awesome-projects - CakePHP I18n - Message translation and localization for dates and numbers. (PHP / Internationalisation and Localisation)
- awesome-php - CakePHP I18n - Message translation and localization for dates and numbers. (Table of Contents / Internationalisation and Localisation)
README
[](https://packagist.org/packages/cakephp/i18n)
[](LICENSE.txt)
# CakePHP Internationalization Library
The I18n library provides a `I18n` service locator that can be used for setting
the current locale, building translation bundles and translating messages.
Additionally, it provides the `Time` and `Number` classes which can be used to
output dates, currencies and any numbers in the right format for the specified locale.
## Usage
Internally, the `I18n` class uses [Aura.Intl](https://github.com/auraphp/Aura.Intl).
Getting familiar with it will help you understand how to build and manipulate translation bundles,
should you wish to create them manually instead of using the conventions this library uses.
### Setting the Current Locale
```php
use Cake\I18n\I18n;
I18n::setLocale('en_US');
```
### Setting path to folder containing po files.
```php
use Cake\Core\Configure;
Configure::write('App.paths.locales', ['/path/with/trailing/slash/']);
```
Please refer to the [CakePHP Manual](https://book.cakephp.org/4/en/core-libraries/internationalization-and-localization.html#language-files) for details
about expected folder structure and file naming.
### Translating a Message
```php
echo __(
'Hi {0,string}, your balance on the {1,date} is {2,number,currency}',
['Charles', '2014-01-13 11:12:00', 1354.37]
);
// Returns
Hi Charles, your balance on the Jan 13, 2014, 11:12 AM is $ 1,354.37
```
### Creating Your Own Translators
```php
use Cake\I18n\I18n;
use Cake\I18n\Package;
I18n::translator('animals', 'fr_FR', function () {
$package = new Package(
'default', // The formatting strategy (ICU)
'default', // The fallback domain
);
$package->setMessages([
'Dog' => 'Chien',
'Cat' => 'Chat',
'Bird' => 'Oiseau'
...
]);
return $package;
});
I18n::getLocale('fr_FR');
__d('animals', 'Dog'); // Returns "Chien"
```
### Formatting Time
```php
$time = Time::now();
echo $time; // shows '4/20/14, 10:10 PM' for the en-US locale
```
### Formatting Numbers
```php
echo Number::format(100100100);
```
```php
echo Number::currency(123456.7890, 'EUR');
// outputs €123,456.79
```
## Documentation
Please make sure you check the [official I18n
documentation](https://book.cakephp.org/4/en/core-libraries/internationalization-and-localization.html).
The [documentation for the Time
class](https://book.cakephp.org/4/en/core-libraries/time.html) contains
instructions on how to configure and output time strings for selected locales.
The [documentation for the Number
class](https://book.cakephp.org/4/en/core-libraries/number.html) shows how to
use the `Number` class for displaying numbers in specific locales.