README

Lingo lets developers define keys in yml-files in the same style as the normal lang-files but that can be viewed and translated from within the SilverStripe admin.

Requirements

SilverStripe 4 (tested with 4.12 and PHP 8.1.0)

Installation

composer require northcreationagency/silverstripe-lingo

How to use

Set the location of the file/s that should be used for the texts to be handled in the yml config file of your project, ie: app/_config/mysite.yml

moduleCatalog is the catalog that the textCatalog is placed in (at the "first level").

textCatalog is the catalog that will contain the yml-files to be read by the module.

Example: app/lingotext

Where app is the "moduleCatalog" and lingotext is the "textCatalog".

NorthCreationAgency\SilverStripeLingo\Lingo:
  moduleCatalog: app
  textCatalog: lingotext

Place one or more yml-files (one for each language) for your texts in the textCatalog catalog. The files should follow the same structure as SilverStripes yml lang files. Example:

en:
  List:
    Header: 'This is a list header'
  Company:
    Header: This is a company header

Sync the texts to the database

To sync the texts from the yml files to the database add a url variable to the build url, like this: dev/build?synclingo=1

Then when you run dev/build?synclingo=1 the texts in the yml-file(s) are read and stored in the database and can be edited from the admin. The Lingo cache is also cleared on build.

You can also add an extra config variable if you want it to always sync the lingo texts upon build. If you do the config like this the lingo texts will be read and synced to the database upon every dev/build without the need to use the url variable.

NorthCreationAgency\SilverStripeLingo\Lingo:
  moduleCatalog: app
  textCatalog: lingotext
  syncOnBuild: true

There is also a task that can be used to sync the texts to the DB. You can run it via dev/tasks/SyncLingoTask .

Usage

Use the SilverStripe translation functions as you would normally use the Silverstripe translate function.

It will first search the regular yml-files for the entity. If it not exists there it will check if a Lingo translation entity exists in the DB. If it does the value of that will be cached and returned.

Use in php function


// Simple string translation
_t('LeftAndMain.FILESIMAGES','Files & Images');

// Using injection to add variables into the translated strings.
_t('CMSMain.RESTORED',
    "Restored {value} successfully",
    ['value' => $itemRestored]
);

Use in template

//with string
<%t Foo.BAR 'Bar' %>

//with variable
<%t Member.WELCOME 'Welcome {name} to {site}' name=$Member.Name site="Foobar.com" %>

northcreationagency / silverstripe-lingo

Maintainers

Details