Custom Resource Services

If you elect not to use property files for your resource bundles, or need to expand your i18n implementation to include content pulled from other sources, the module allows for the specification of a customResourceService in the configuration.
To begin, create a custom resource service which extends the core i18n resource service:
1
component 
2
  name="MyCustomResourceService" 
3
  extends="cbi18n.models.ResourceService" 
4
  singleton=true{
5
  
6
  property name="Controller" inject="coldbox";
7
  property name="Wirebox" inject="wirebox";
8
​
9
}
Copied!
To override the resource bundle used, you would declare a new loadResourceBundle method. To override the implementation of the getResource( i18nResourceLabel ) you would declare a new getResource method. An example, using your database to retrieve an i18n resource bundle:
1
public void function loadBundle( 
2
    required string rbLocale=VARIABLES.i18n.getfwLocale() 
3
){
4
    var bundles = "";
5
​
6
    // Lazy Load?
7
    if( NOT VARIABLES.controller.settingExists("RBundles") ){
8
        VARIABLES.controller.setSetting("RBundles",structnew());
9
    }
10
​
11
    //set bundles ref
12
    bundles = VARIABLES.controller.getSetting("RBundles");
13
    var rb = structNew();
14
​
15
    //cache our resource bundle query
16
    var qRb = new query( datasource=application, cachedWithin=CreateTimeSpan(0, 6, 0, 0) );
17
    qRb.addParam( name="locale", value=arguments.rbLocale, cfsqltype="cf_sql_varchar" );
18
    qRb.setSQL( "SELECT * from customI18nTable WHERE locale=:locale" );
19
    var rbResult = = qRb.execute().getResult();
20
    for( var resource in rbResult ){
21
        rb[ resource.label ] = resource.value;
22
    }
23
​
24
    bundles[ arguments.rbLocale ] = rb;
25
}
Copied!
Lets say we want to account for a more complex metadata structure in our resource bundles. For example, allow a draft value to allow for administrators to see which items in our bundle are pending review but display the default value to the public. We might also want to add any new resource requests containing a default value as drafts in the system (which we won't cover here). For special circumstances, such as these, we would need to change the implementation of the getResource method to account for this draft functionality:
1
public string function getResource(
2
    // The resource (key) to retrieve from the main loaded bundle.
3
    required any resource,
4
    //A default value to send back if the resource (key) not found
5
    any default,
6
    //Pass in which locale to take the resource from. By default it uses the user's current set locale
7
    any locale="#VARIABLES.i18n.getfwLocale()#",
8
    //An array, struct or simple string of value replacements to use on the resource string
9
    any values,
10
    //default
11
    any bundle="default"
12
){
13
    //prevent errors via empty label strings from being passed
14
    if( !len( trim(resource) ) ) return resource;
15
​
16
    //protect from a bad locale value being passed
17
    if( !len( trim( arguments.locale ) ) ) arguments.locale = VARIABLES.i18n.getfwLocale();
18
​
19
    var thisLocale         = arguments.locale;
20
    var resourceString = "";
21
​
22
    var rBundles = Controller.getSetting("RBundles");
23
    var currentUser = Wirebox.getInstance( "SessionService" ).getCurrentUser();
24
​
25
    if( !structKeyExists( rBundles, arguments.locale ) ){
26
        loadBundle( rbLocale=arguments.locale, rbAlias=arguments.bundle );
27
    }
28
​
29
    var resourceBundle = rBundles[ arguments.locale ];
30
​
31
    if( structKeyExists( resourceBundle, arguments.resource  ){
32
        var resource = resourceBundle[ arguments.resource ];
33
        if( resource.published ){
34
            return formatResourceObject( resourceObj=resource, args=arguments );
35
        } else if( !resource.published && currentUser.isAdministrator() ) {
36
            return formatDraftResource( resourceObj=resource, args=arguments );
37
        }
38
    } else if( !isNull( arguments.default ) ) {
39
        if( !isNull( arguments.values ) ){
40
            return formatRBString( arguments.default, arguments.values );
41
        } else {
42
            return arguments.default;
43
        }
44
    } else {
45
        return renderUnknownTranslation( arguments.resource );
46
    }
47
}
Copied!
The ability to extend and implement custom resource services provides you with a great deal of flexibility in your internationalization efforts. Use cases might include database-driven i18n resources, distributed caching implementations, and variable bundle formats used in third-party tools and plugins.
Resource Bundle Tools
Next - Usage
How do I change Locales?
Last modified 11mo ago
Copy link
Edit on GitHub