WELCOME TO THE COLDBOX I18N & LOCALIZATION MODULE

This module will enhance your ColdBox applications with i18n (internationalization) capabilities, resource bundles and localization. It supports traditional Java resource bundles and also modern JSON resource bundles.

LICENSE

Apache License, Version 2.0.

IMPORTANT LINKS

• Documentation: https://coldbox-i18n.ortusbooks.com/
• Source: https://github.com/coldbox-modules/cbi18n
• ForgeBox: https://forgebox.io/view/cbi18n
• Changelog

SYSTEM REQUIREMENTS

• Lucee 5+
• Adobe ColdFusion 2018+

INSTRUCTIONS

Leverage CommandBox and install it:

box install cbi18n

This module registers the following models in WireBox:

• i18n@cbi18n : Helper with all kinds of methods for localization
• resourceService@cbi18n : Service to interact with language resource bundles - You may override this service by providing a customResourceService key in your configuration. More information on custom resource services.

Settings

You can add a cbi18n structure of settings to your modulesettings in ColdBox.cfc or to any other module configuration file: ModuleConfig.cfc to configure the module:

// config/ColdBox.cfc
moduleSettings =
	cbi18n = {
		// The base path of the default resource bundle to load
		// base path is path + resource name but excluding _lang_COUNTRY.properties
		defaultResourceBundle = "includes/i18n/main",
		// The default locale of the application
		defaultLocale = "en_US",
		// The storage to use for user's locale: any cbstorages service. Please use full wirebox ID
		localeStorage = "CookieStorage@cbstorages",
		// The value to show when a translation is not found
		unknownTranslation = "**NOT FOUND**",
		logUnknownTranslation = true | false,
		// Extra resource bundles to load, specify path up to but not including _lang_COUNTRY.properties here
		resourceBundles = {
			alias = "path"
		},
		//Specify a Custom Resource Service, which should implement the methods or extend the base i18n ResourceService ( e.g. - using a database to store i18n )
		customResourceService = ""
	}
}

Each module in your ColdBox Application can have its own resource bundles that can be loaded by this module as well. Just configure it via the cbi18n key in your ModuleConfig.cfc

function configure(){

	cbi18n = {
		defaultLocale = "es_SV",
		resourceBundles = {
			// Alias => path in module
			"module@test1" = "#moduleMapping#/includes/module"
		}
	};

}

Interceptors

This module announces an onUnknownTranslation interception. The data announced is a struct with the following format:

{
	resource 	= ...,
	locale 		= ... ,
	bundle  	= ...
}

Mixin Helpers

The module registers the following methods for handlers/layouts/views/interceptors:

/**
* Get the user's currently set locale or default locale according to settings
*/
function getFWLocale()

/**
* Set the locale for a specific user
* @locale The locale to set. Must be Java Style Standard: en_US, if empty it will default to the default locale
* @dontLoadRBFlag Flag to load the resource bundle for the specified locale (If not already loaded)
*
* @return i18n Service
*/
function setFWLocale( string locale="", boolean dontloadRBFlag=false )

/**
* Retrieve a resource from a resource bundle with replacements or auto-loading
* @resource The resource (key) to retrieve from the main loaded bundle.
* @defaultValue A default value to send back if the resource (key) not found
* @locale Pass in which locale to take the resource from. By default it uses the user's current set locale
* @values An array, struct or simple string of value replacements to use on the resource string
* @bundle The bundle alias to use to get the resource from when using multiple resource bundles. By default the bundle name used is 'default'
*/
function getResource(
    required resource,
    defaultValue,
    locale,
    values,
    bundle,
)

// Alias to getResource
function $r()

/**
 * Get Access to the i18n Model
 */
function i18n()

/**
 * Get the resource service model
 */
function resourceService()

You can read more about this module here: https://coldbox-i18n.ortusbooks.com

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com

HONOR GOES TO GOD ABOVE ALL

Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.

"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God. And not only so, but we glory in tribulations also: knowing that tribulation worketh patience; And patience, experience; and experience, hope: And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the Holy Ghost which is given unto us. ." Romans 5:5

THE DAILY BREAD

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12