yazeed-obaid/laravel-lang

Modular Export of Laravel translations for Front-End and API usage.

Laravel-Lang

, _(*1)

Modular Export of Laravel translations for Front-End and API usage., _(*2)

This package is inspired from the the way how CMSs built on top of Laravel work and how they are structured into packages for large-scale applications. In these CMSs, each package has its own langdirectory., _(*3)

Also, this package has an exclude array to exclude lang files from each lang directory in these modular packages. And finally, an event is emitted after export is done., _(*4)

Installation

Require this package, with Composer, in the root directory of your project., _(*5)

``` bash $ composer require yazeedobaid/laravel-lang, <sub>(*6)</sub>

## Assets Publishing

To publish the config file of the package use:

``` php
php artisan vendor:publish --provider=YazeedObaid\Lang\LaravelLangServiceProvider --tag=config

Usage

Add this route to your Front-End side or call it as an API. http://your-web-app/js/lang.js, <sub>(*7)</sub>

Config File

The config file contains configurations for the route to use for the translations, a middlewares array for the route to be applied to it. An events channel, to specify the event channel., <sub>(*8)</sub>

The keys for the 'paths' and 'files_to_exclude' arrays must be the same, since these keys define each package name (alias). Feel free to select you prefered name., <sub>(*9)</sub>

Example config file

Below is an example on the path of a package to get its translations with a excluded trans file in that package:, <sub>(*10)</sub>

``` php 'paths' => [ /** * For each package in your project you can define the relative path to that * package from your root app directory to the lang directory in that package * to use it in export to Vue. The default path to Laravel applications which * is /resources/lang is set by default to you * */, <sub>(*11)</sub>

    /**
     * Default path is the resources/lang path.
     * */
    'default' => '/resources/lang',



    /**
     * Here you define a path for each package you want to export the
     * translations for.
     * */
    'my-package' => '/packages/myPckage/src/resources/lang'
],


'files_to_exclude' => [
    /**
     * In each package you define above in the paths array you can exclude files
     * in that package and not to include them in export to Vue process. Use the
     * same key you use above to exclude files in each package. The below is an
     * example of excluding the auth file in default Laravel translations
     * location.
     * */


    /*'default' => [
        'auth'
    ]*/
]

```, <sub>(*12)</sub>

A Note to be Mentioned

This package was inspired from kg-bot/laravel-localization-to-vue., <sub>(*13)</sub>