Download the PHP package roi-up-agency/laravel-translatable without Composer
On this page you can find all versions of the php package roi-up-agency/laravel-translatable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download roi-up-agency/laravel-translatable
More information about roi-up-agency/laravel-translatable
Files in roi-up-agency/laravel-translatable
Package laravel-translatable
Short Description A trait to make an Eloquent model hold translations
License MIT
Homepage https://github.com/spatie/laravel-translatable
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 laravel-translatable
A trait to make Eloquent models translatable
This package contains a trait to make Eloquent models translatable. Translations are stored as json. There is no extra table needed to hold them.
Once the trait is installed on the model you can do these things:
Installation
You can install the package via composer:
If you want to have another fallback_locale then the app fallback locale (see config/app.php), you could publish the config file:
This is the contents of the published file:
Making a model translatable
The required steps to make a model translatable are:
- First, you need to add the
Spatie\Translatable\HasTranslations-trait. - Next, you should create a public property
$translatablewhich holds an array with all the names of attributes you wish to make translatable. - Finally, you should make sure that all translatable attributes are set to the
text-datatype in your database. If your database supportsjson-columns, use that.
Here's an example of a prepared model:
Available methods
Getting a translation
The easiest way to get a translation for the current locale is to just get the property for the translated attribute.
For example (given that name is a translatable attribute):
You can also use this method:
This function has an alias named translate.
Getting all translations
You can get all translations by calling getTranslations() without an argument:
Or you can use the accessor
Setting a translation
The easiest way to set a translation for the current locale is to just set the property for a translatable attribute.
For example (given that name is a translatable attribute):
To set a translation for a specific locale you can use this method:
To actually save the translation, don't forget to save your model.
Validation
- if you want to validate an attribute for uniqueness before saving/updating the db, you might want to have a look at laravel-unique-translation which is made specifically for laravel-translatable.
Forgetting a translation
You can forget a translation for a specific field:
You can forget all translations for a specific locale:
Getting all translations in one go
Setting translations in one go
Here's an example:
Events
TranslationHasBeenSet
Right after calling setTranslation the Spatie\Translatable\Events\TranslationHasBeenSet-event will be fired.
It has these properties:
Creating models
You can immediately set translations when creating a model. Here's an example:
Querying translatable attributes
If you're using MySQL 5.7 or above, it's recommended that you use the json data type for housing translations in the db. This will allow you to query these columns like this:
Changelog
Please see CHANGELOG for more information what has changed recently.
Upgrading
From v2 to v3
In most cases you can upgrade without making any changes to your codebase at all. v3 introduced a translations accessor on your models. If you already had one defined on your model, you'll need to rename it.
Testing
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Freek Van der Herten
- Sebastian De Deyne
- All Contributors
We got the idea to store translations as json in a column from Mohamed Said. Parts of the readme of his multilingual package were used in this readme.
Support us
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.
