Download the PHP package bayfrontmedia/translation without Composer
On this page you can find all versions of the php package bayfrontmedia/translation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bayfrontmedia/translation
More information about bayfrontmedia/translation
Files in bayfrontmedia/translation
Package translation
Short Description A PHP translation library utilizing multiple language storage options.
License MIT
Homepage https://github.com/bayfrontmedia/translation
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 translation
Translation
A PHP translation library utilizing multiple language storage options.
- License
- Author
- Requirements
- Installation
- Usage
License
This project is open source and available under the MIT License.
Author
Requirements
- PHP
^8.0 - JSON PHP extension
- PDO PHP extension
Installation
Usage
NOTE: It is up to you to populate the translation data, no matter where it is stored. This library simply reads the existing data from its source.
Storage adapter
A Bayfront\Translation\ApadpterInterface must be passed to the Bayfront\Translation\Translate constructor.
There are a variety of storage adapters available, each with their own required configuration.
Defined array
The defined array adapter allows you to use a predefined array containing all of your translations.
Local
The local adapter allows you to use local native PHP files containing all of your translation arrays.
The file structure from the root path should be:
For example, if the locale is set as en, the method say('dashboard.greeting') will search for the file /root_path/en/dashboard.php, and the array key greeting.
Example dashboard.php:
PDO
The PDO adapter allows you to use a \PDO instance for language retrieval from a database, and may throw a Bayfront\Translation\AdapterException exception in its constructor.
To create a compatible table, execute the following statement:
This table structure ensures only one row exists with a matching locale and id.
The contents column should contain a JSON encoded array.
The PDO adapter will create/use a table named "translations" unless otherwise specified in the constructor.
Start using Translation
Once your adapter has been created, it can be used with Translation. In addition, a string defining the locale should be passed to the constructor.
The last argument is true by default.
When true, if a translation is not found and $default = NULL, the original string is returned.
If false, a Bayfront\Translation\TranslationException is thrown.
Public methods
- getLocale
- setLocale
- getTranslations
- addTranslations
- get
- say
- replace
- replaceAll
getLocale
Description:
Get locale.
Parameters:
- None
Returns:
- (string)
Example:
setLocale
Description:
Set locale.
Parameters:
$locale(string)
Returns:
- (self)
Example:
getTranslations
Description:
Return array of all known translations.
Translations are only "known" once their ID has been used, or they have been added via the addTranslations method.
Parameters:
- None
Returns:
- (array)
Example:
addTranslations
Description:
Add translations to the known translations for the current request only.
Parameters:
$translations(array)
Returns:
- (self)
Example:
get
Description:
Return the translation for a given string.
The string format is: id.key.
Keys are in array dot notation, so they can be as deeply nested as needed.
Replacement variables should be surrounded by {{ }} in the original string.
If a translation is not found and $default = NULL, either the original string is returned, or a TranslationException is thrown, depending on the setting chosen in the constructor.
Parameters:
$string(string)$replacements = [](array)$default = NULL(mixed): Default value to return if translation is not found
Returns:
- (mixed)
Throws:
Bayfront\Translation\TranslationException
Example:
say
Description:
Echos the translation for a given string.
Parameters:
$string(string)$replacements = [](array)$default = NULL(mixed): Default value to return if translation is not found
Returns:
- (void)
Throws:
Bayfront\Translation\TranslationException
Example:
replace
Description:
Replace case-sensitive values in a string.
Parameters:
$string(string): Original string$replacements = [](array): Array of values and replacements
Returns:
- (string)
Example:
replaceAll
Description:
Replace multiple case-sensitive values in a string with a single replacement.
Parameters:
$string(string): Original string$values(array): Array of values to replace$replacement(string)
Returns:
- (string)
Example:
All versions of translation with dependencies
bayfrontmedia/php-array-helpers Version ^2.0
ext-pdo Version *
ext-json Version *