LibLocalisation by Netcarver

Contains localisations for currency, language and countries.

Localisation Library for Countries, Languages and Currencies

This library contains packaged publicly available data taken from an older version of Umpirsky's Country List before it specialised just in country localisations.

Prerequisites


  • A working PW3.0.98+ installation.

Installation


Via Modules Page In Admin

  • Install using module class name of "LibLocalisation"

Usage Examples


To create a localisation for a particular locale, first create a new instance and define the locale...

$de_DE = wire('modules')->get('LibLocalisation')->setLocale('de_DE');

You can now use your locale to get information about countries, currencies and languages as they are used in that locale. For example, to output the names of various countries you use the country() method, passing in an ISO 3166-2 country code...

echo $de_DE->country('CH'); // Outputs "Schweiz" - the German for Switzerland.
echo $de_DE->country('AU'); // Outputs "Australien" - the German for Australia.
echo $de_DE->country('US'); // Outputs "Vereinigte Staaten" - ditto for the United States of America.

You can create as many instances of the module as you need and set them all up for the same, or different, locales.

To access currency data, you call the currency() method, passing in the currency code you are interested in.

echo $de_DE->currency('GBP');

This returns an array of data about GBP - localised in German...

[
digits => 2,
number => "826",
symbol => "£",
name => "Britisches Pfund Sterling"
]

Finally, you can output localised language names by calling the language() method and giving it a language code.

echo $de_DE->language('fr'); // Outputs "Französisch" - the German for French.

File structure for localisation data


The data is housed under the data/ subdirectory and is arranged by major language code. Sub locales hold specialisations of the parent language entries, and this structure prevents much repetition in the data set.

data/
  |-- ar  << 2 letter folders hold files containing localisations
  .         for the base language they represent.
  .
  .
  |-- common             - This folder holds various data common to all areas.
  .
  .
  .
  |-- en                 - This folder holds general English localisations.
  |    |-- currency.php
  |    |-- language.php
  |    \-- country.php   - This file has the country name mappings in English.
  |
  |-- en_GB
  |     \-- country.php  - This file holds the just the diffs from en/country.php country name mappings.
  |
  |-- fr                 - This folder has the French localisations.
  |    |-- currency.php
  |    |-- language.php
  |    \-- country.php
  |
  |-- fr_FR
  |     |-- language.php
  |     \-- country.php
  .
  .
  .

License(s)


Umpirsky's Country List data was used as the source for the files under the data/ directory and that project uses a MIT License. My module is also issued under a MIT license (See LICENSE.txt.)

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • This week, in addition to the regular core updates, we have new versions of ProcessWire ProFields Table and ProFields Combo that add support for their own file and image types— More
    19 August 2022
  • New ProcessWire “User Activity” module version released (v5), this post covers what's new— More
    12 August 2022
  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022

Latest news

  • ProcessWire Weekly #431
    In the 431st issue of ProcessWire Weekly we'll check out the weekly update from Ryan in which he covers a new version of a popular Pro module, share some recent tutorials and other online resources, and more. Read on!
    Weekly.pw / 13 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer