Download the PHP package ahmedash95/laravel-translatable without Composer
On this page you can find all versions of the php package ahmedash95/laravel-translatable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ahmedash95/laravel-translatable
More information about ahmedash95/laravel-translatable
Files in ahmedash95/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
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:
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
Installation
You can install the package via composer:
Next up, the service provider must be registered:
If you want to change add fallback_locale, you must 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
$translatable
which 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
.
Setting a translation
Forgetting a translation
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:
In laravel 5.2.23 and above you can use the fluent syntax:
Changelog
Please see CHANGELOG for more information what has changed recently.
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.
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 multiligual package were used in this readme.
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.