sirgrimorum/transarticles

Localization using db table as source for translated text

SirGrimorum's TransArticles

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Localization using a datablase table for Laravel 5.6. Include a function to add Translation form DB to javascript., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require :sirgrimorum/transarticles, <sub>(*4)</sub>

Create Table

``` bash
$ php artisan migrate

OPTIONAL: Publish configuration file, <sub>(*5)</sub>

``` bash $php artisan vendor:publish --tag=config, <sub>(*6)</sub>

## Usage

Bring a translated article

``` php
$text = TransArticles::get("scope.nickname");

OR ``` php $text = trans_article("scope.nickname");, <sub>(*7)</sub>

## Articles to JavaScript

Load javascript object with all translations of a given scope

``` html
{!! TransArticles::getjs('scope') !!}
<script>
    (function() {
        alert(translations.scope.nickname);
    })();
</script>

Load javascript object with translated article, <sub>(*8)</sub>

``` html {!! TransArticles::getjs('scope.nickname') !!} , <sub>(*9)</sub>

## Blade directives


Bring a translated article using the Blade directive

``` html
@transarticles("scope.nickname")

Load javascript object with all translations of a given scope using the Blade directive, <sub>(*10)</sub>

``` html @transarticles_tojs('scope') , <sub>(*11)</sub>

Load javascript object with translated article using the Blade directive

``` html
@transarticles_tojs('scope.nickname')
<script>
    (function() {
        alert(translations.scope.nickname);
    })();
</script>

When using blade directives, remember to clear de view:cache after each change in the articles table:, <sub>(*12)</sub>

``` bash $php artisan view:clear, <sub>(*13)</sub>

## Seeding

TransArticles installs orangehill/iseed to create seed files from the DataBase data. There are 2 new commands:

To create seed files from the Articles table:
``` bash
$php artisan transarticles:createseed

To create seed files from ALL the tables in de DataBase except the migrations table: ``` bash $php artisan transarticles:createseed --all, <sub>(*14)</sub>

To create seed files from ALL the tables in de DataBase except the migrations table without suffix and forcing overwrite of prior seed files:
``` bash
$php artisan transarticles:createseed --all --force

Security

If you discover any security related issues, please email andres.espinosa@grimorum.com instead of using the issue tracker., <sub>(*15)</sub>

Credits

• SirGrimorum link-author
• Grimorum Ltda. link-contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*16)</sub>