Download the PHP package northcreationagency/silverstripe-lingo without Composer
On this page you can find all versions of the php package northcreationagency/silverstripe-lingo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download northcreationagency/silverstripe-lingo
More information about northcreationagency/silverstripe-lingo
Files in northcreationagency/silverstripe-lingo
Package silverstripe-lingo
Short Description Translate and handle keys from yml-files from within the SilverStripe admin.
License BSD-3-Clause
Homepage https://github.com/northcreation-agency/silverstripe-lingo
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silverstripe-lingo
Lingo
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".
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:
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.
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.
