README

This package used for multilingual website in Laravel framework.

Install

[ step : 1]

composer require mekaeil/laravel-translation

Vendor Publish [ step : 2]

This files would be published after run bottom command:

Resource files for admin panel
Asset files for admin panel in public path
Config file ( config > laravel-translation.php )
Route file ( routes > route.laratrans.php )
Translation Helper ( app > LaraTransHelper )

php artisan vendor:publish

Migration [ step : 3 ]

before migration you should take a look the config file.

define your users table, user model and user id
if you want to change the translation's table name you can change it.
add or edit middleware routes.

it is important to add lang_id in your fillable columns in user model.

config > laravel-translation.php

After that you can migrate.

php artisan migrate

Add Provider : config > app.php

\Mekaeil\LaravelTranslation\LaravelTranslationProvider::class,

Add Middleware in Kernel File

use Mekaeil\LaravelTranslation\Http\Middleware\SetRouteBaseLocale;
use Mekaeil\LaravelTranslation\Http\Middleware\UserLocale;

-----

UserLocale::class,
SetRouteBaseLocale::class,

Add this Route:
in this route redirect to base locale.

Route::get('{uri?}', [
    'uses'      => 'PublicTransController@changeLocale',
])->where('uri', '.*');

Create PublicTransController in your path controller and add this function for set redirection.

    public function changeLocale(Request $request)
    {
        $locale = \Cookie::get('language') ?? app()->getLocale();
        $getURL = Translation::getUrlBaseLocale($locale);

        if (! \Request::is($getURL))
        {
            $newUrl = str_replace('/'.$locale,'',$getURL);
            return redirect()->to($newUrl);
        }

        return Translation::uri($getURL,$locale,'redirect');
    }

SEEDS [ step : 4 ]

.... comming ....

MAIN URLS / ROUTES

* http://your-domain.com/admin/translation/languages    (Route: admin.trans.lang.index)
* http://your-domain.com/admin/translation/base/list    (Route: admin.trans.base.index)
* http://your-domain.com/admin/translation/modules/list (Route: admin.trans.module.index)    
* http://your-domain.com/admin/translation/assets/list  (Route: admin.trans.assets.index)

Usage

Blade

you can use it in your blade:

translation($text,$lang,$where)

_trans($text,$lang,$where)

$lang and $where are optional. ( Default $lang set base your locale project )
$where can be one of the 'file' or 'db' ( Default is 'file')

Get translation from Database with key in English language:

translation('welcome','en','db')

_trans('welcome','en','db')

search 'welcome' key in 'file' language.

translation('welcome')

_trans('welcome')

search 'welcome' in Database and display it, but if could not find it just call this method translation('welcome')

translation('welcome',null,'db')

_trans('welcome',null,'db')

It is important if you have html tag in your translation value when inserting in Database you should be use {!! !!} like this:

{!! translation('welcome','en','db') !!}

{!! _trans('welcome','en','db') !!}

{{ getUserLocale() }}

Language locale and Direction saving in cookie or session, but if you want to getUserLocale you can use this method in your blade.

first argument : $user [ if you want to get user local ]
second argument : [ lang , dir ] if you don't set anything return language data with json format.

{{ getUserLocale(null,'lang') }} // output : en

Get direction

{{ getUserLocale(null,'dir') }} // output : ltr

Get User Locale

{{ getUserLocale(\Auth::user()) }}
/// output:
{
    "id": 1,
    "name": "en",
    "display_name": "English",
    "status": 1,
    "default": 0,
    "created_at": "2019-01-03 08:40:32",
    "updated_at": "2019-01-17 11:00:50",
    "direction": "ltr"
}

And an other way to get user locale

{{ getUserLocale() }}

/// output :
{
    "id": 1,
    "name": "en",
    "display_name": "English",
    "status": 1,
    "default": 0,
    "created_at": "2019-01-03 08:40:32",
    "updated_at": "2019-01-17 11:00:50",
    "direction": "ltr"
}

IMPORTANT

if you want to use getUserLocale() don't pass any argument because if the user logged in his/her account return user's language otherwise returns the default language in your project.

AJAX SWITCH LANGUAGE / CHANGE LOCALE

[1]: In controller pass this data to view

$langs      = Translation::allLangs(true,true); // get data with pluck
 
return view('home', compact('langs'));

[2]: Create selec box:

<select class="switchLang">
    @foreach($langs as $key => $value)
        <option value="{{ $key }}" {{ $key == \Cookie::get('language') ? 'selected' : '' }} >{{ $value }}</option>
    @endforeach
</select>
 
//////// OUTPUT :
 
<select class="switchLang">
    <option value="en" selected="selected">English</option> 
    <option value="fa">فارسی</option>
    <option value="ku">کوردی</option>
</select>

[3]: Set AJAX in jQuery

<script>
    $(document).ready(function () {


            // ON CHANGE SELECT
            $('select.switchLang').on('change', function () {

                var languageID  = $(this).find(":selected").val();
                var route       = "{{ route(config('laravel-translation.switch_language')) }}";
                var userID      = "{{ \Auth::user() ? \Auth::user()->id : null }}";


                $.ajaxSetup({
                    headers: {
                        'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
                    }
                });

                var formData = new FormData();
                formData.append('lang', languageID);
                formData.append('userID', userID);

                $.ajax({
                    url           : route,
                    type          : 'POST',
                    data          : formData,
                    contentType   : false,
                    processData   : false,

                    success: function(data)
                    {
                        // console.log(data.url);
                        console.log('Language changed successfully!');
                        // location.reload();
                        window.location.replace(data.url)
                    },
                    error: function () {
                        console.log('Error Response!!!');
                    }
                });

            });
            
            

    });
</script>

Another Style [ button click]

<div class="lang-switch lang-button" style="top: -195px;">
    @foreach($langs as $key => $value)
        <span class="{{ $key == \Cookie::get('language') ? 'active' : '' }}" data-key="{{ $key }}">{{ $value }}</span>
    @endforeach
</div>

Ajax :

    // CLICK BUTTON
    $('.lang-switch > span').on('click', function ()
    {
        if($(this).hasClass("active")){
            return false;
        }

        var languageID  = $(this).data('key');
        var route       = "{{ route(config('laravel-translation.switch_language')) }}";
        var userID      = "{{ \Auth::user() ? \Auth::user()->id : null }}";

        $.ajaxSetup({
            headers: {
                'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
            }
        });


        $.ajaxSetup({
            headers: {
                'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
            }
        });

        var formData = new FormData();
        formData.append('lang', languageID);
        formData.append('userID', userID);

        $.ajax({
            url           : route,
            type          : 'POST',
            data          : formData,
            contentType   : false,
            processData   : false,

            success: function(data)
            {
                console.log(data.url);
                console.log('Language changed successfully!');
                window.location.replace(data.url)
            },
            error: function () {
                console.log('Error Response!!!');
            }

        });

    });

Create your own helper function in Blade theme

You can define your helper function for translate words in your blade theme. use this in top of the file :

use Mekaeil\LaravelTranslation\Repository\Facade\Translation;

add this function in your helper file.

if (!function_exists('YOUR_FUNCTION_NAME'))
{

    /**
     * @param $word
     * @param null $lang
     * @param string $where
     * @return mixed
     */
    function YOUR_FUNCTION_NAME($word, $lang=null, $where='file')
    {
        return Translation::translation($word,$lang,$where);
    }

}

Controller

first you should use TransHelper in you controller.

use Mekaeil\LaravelTranslation\Repository\Facade\Translation;

Languages

Get all of the languages base collection

Translation::allLangs();

Get ACTIVE languages base collection

Translation::allLangs(true);

Get ACTIVE languages base PLUCK Data

Translation::allLangs(true,true);

Get Default language in the project.

Translation::defaultLang();

Get User Default Language, if the user selected language in the self-account, otherwise returns default language in the system.

$user = Auth::user();
return Translation::defaultLang($user->id);

Base Translation Words

Get all of the words in database :

Translation::baseWords();

Get English words ( paginate : 15 )

Translation::baseWords(null ,'en' , 15);

Get welcome word in Persian language

Translation::baseWords('welcome' ,'fa');

Get welcome word base current local

Translation::baseWords('welcome');

Set User Language:

$userID : User id (int)
$langID : Language id (int) (default: null)
$langWith : cookie or session, (string) (default:cookie)

Translation::setUserLocale($userID, $langID, $langWith)

Setting the user's language with id: 27 to the language that user selected before!

Translation::setUserLocale(27)

Set the user's language with id:27 to the language with id:3

Translation::setUserLocale(27,3)

Set the user's language with id:27 to the language with id:3 and use session for user

Translation::setUserLocale(27,3,'session')

Clear Cache

It's important before anything set config file, in laravel-translation config file you can set type of save user data in browser on Cookie or Session.

Clear Cache An Item In Session

Translation::clearCache('language','session');

Clear Cache An Array In Session

Translation::clearCache(['language','direction'],'session');

If you set the storage save data, it doesn't need to pass second argument.

Clear Cache An Item

Translation::clearCache('language');

Clear Cache An Array

Translation::clearCache(['language','direction']);

Clear all of the SESSION exists in user's browser

Translation::clearCache('all','session');

ASSETS

Ger Assets function

$where : default = front-end [ front-end, back-end]
$type : default = null [link_style,styleـcustom,link_script,scriptـcustom]
$lang : default = null, use default locale [en,fa]

Translation::getAssets($where, $type, $lang)

Get all of the assets added for Front-End

Translation::getAssets($where='front-end')

GET ASSET DEFINED IN COOKIE

Get and save style defined for language in blade

    @php
        setAssets();
        $asset =\Cookie::get('assets');
        $asset =json_decode($asset);
    @endphp

    @if($asset)
        ///// create style and script tags
        {!! $asset->link_style ?? '' !!}
        {!! $asset->link_script ?? '' !!}
    @endif

Or add custom style in master blade file.

@if( \Cookie::get('direction') == 'rtl' )
    <link rel="stylesheet" href="{{ asset('css/rtl.css') }}">
@endif