README

A plugin for Laravel Lang that provides generic term translations for Laravel project.

Consult the glossary to see all the terms available for translation.

Installation

Require the project using Composer:

composer require forxer/generic-term-translations-for-laravel --dev

Upgrading from 1.x? Read the upgrade guide first.

Then use the locales publisher of Laravel Lang to add/update/reset or remove translations of this package:

If you have never used Laravel Lang: add locales.
If you are already using Laravel Lang: just update the locales.

Requirements

PHP ^8.4
laravel-lang/publisher ^16.0

Usage

This package provides translations for terms regularly used in projects.

You will find all the terms provided by this package in the glossary.

Terms are categorized into different sections by source files. For example there is an action.php source file that defines the add_something key, you can use it like this:

// "en" locale
trans('action.add_something', [
    'something' => 'a post',
]);

// return: "Add a post"

// "fr" locale
trans('action.add_something', [
    'something' => 'un article',
]);

// return: "Ajouter un article"

Be careful to escape the data that you do not control:

trans('action.delete_something', [
    'something' => e($post->title),
]);

Feminine and masculine gender

Some languages distinguish between feminine and masculine genders, for the same term the feminine key will then be suffixed by _fem. For example:

In English we use "all", while in French we use "toutes" in the feminine and "tous" in the masculine (see it on Google Translate).

// "en" locale
trans('misc.all'); // return: "all"

trans('misc.all_fem'); // return: "all"

// "fr" locale
trans('misc.all'); // return: "tous"

trans('misc.all_fem'); // return: "toutes"

Development steps

From the package directory, run composer update
Update the sources as needed in source/ files
Run the console command php vendor/bin/lang sync
Translate modifications in locales/{locale}/php.json
Run composer glossary to regenerate GLOSSARY.md
Run composer test to check key consistency across locales and that the glossary is up to date
Run composer lint to format the code
Commit changes

GLOSSARY.md is a generated file: it is built from source/ and locales/, and must never be edited by hand. composer test fails when it no longer matches them.

forxer / generic-term-translations-for-laravel

Maintainers

Package info

Statistics

Security