Laravel Translations: Store in PHP or JSON Files?

Summary

This video explores multi-language support in Laravel, comparing the use of PHP files and JSON files for translations. The presenter discusses how translations are structured, the pros and cons of each method, and the impact on both developers and translators. PHP files allow for complex, nested structures and comments but can be difficult for non-developers to work with. JSON files are more user-friendly and accessible for translators but lack the flexibility of PHP files. The video also covers the differences between the `trans()` and `__()` functions, guiding viewers on best practices for managing translations in Laravel.

Takeaways

• 😀 PHP and JSON files are two main ways to store translations in Laravel.
• 😀 PHP files allow for nested structures and provide more flexibility for developers.
• 😀 JSON files are more human-readable and are easier for non-developers, like translators, to use.
• 😀 Laravel 10 no longer includes a Lang folder by default, but it can be created manually or published from core framework translations.
• 😀 If a translation key is missing in PHP files, Laravel will display the key itself, which is not user-friendly.
• 😀 PHP files can have multiple validation files and reusable keys, but they may become confusing for non-developers.
• 😀 JSON files cannot have nested keys, limiting flexibility but making it simpler for translators.
• 😀 Using both PHP and JSON files for the same key can lead to errors, as Laravel would prioritize the PHP file over the JSON one.
• 😀 The `underscore` function in Laravel actually uses the `trans` function under the hood, meaning they work similarly.
• 😀 To avoid confusion, it’s crucial to avoid conflicts between PHP and JSON keys when working with both formats.
• 😀 Laravel’s translation system allows for easy localization, but care must be taken in structuring files to ensure clarity and avoid errors.

Q & A

What is the topic of the first lesson in the multi-language Laravel course?

The topic of the first lesson is about multi-language support in Laravel, specifically comparing PHP files and JSON files for translations, as well as using the 'trans' and 'underscore' helper functions.

What are the two ways to store translation keys in Laravel?

Translation keys in Laravel can be stored in either multiple PHP files or in one large JSON file located in the 'Lang' folder.

What is the structure of translation keys in PHP files?

In PHP files, translation keys follow a dot notation format where the first part represents the language (e.g., 'en'), followed by the filename (e.g., 'auth'), and then the key itself (e.g., 'register.name').

What are some benefits of using PHP files for translations?

Benefits of using PHP files include support for multiple nested levels, the ability to define multiple validation files, and the option to include comments for easier maintenance and understanding.

What are the drawbacks of using PHP files for translations?

Drawbacks include the risk of showing untranslated keys to users, the structure being less user-friendly for non-developer translators, and the potential for disorganization if the files become too numerous.

How does Laravel 10 handle the 'Lang' folder?

In Laravel 10, the 'Lang' folder no longer exists by default. You need to either create it manually or run the 'lang:publish' command to copy the default core translations into the folder.

How do translation keys in JSON files differ from those in PHP files?

In JSON files, the translation keys are stored as human-readable sentences, making them more understandable for non-developer translators, whereas PHP files use a dot notation and may be harder for non-developers to interpret.

What are the benefits of using JSON files for translations?

Benefits of using JSON files include easier readability for non-developers, the ability to send files to external translators, and the simplicity of having one large file for all translations.

What are the drawbacks of using JSON files for translations?

Drawbacks include the inability to use nested keys or comments, and the potential for the file to become very large and disorganized, making it difficult to manage.

What happens if both PHP and JSON files contain the same translation key in Laravel?

If both PHP and JSON files contain the same translation key, Laravel will prioritize the PHP file first. If a key in the PHP file is an array, it can cause an error when the framework expects a string.

What is the difference between the 'trans' and 'underscore' functions in Laravel?

The 'underscore' function internally uses the 'trans' function, so in most cases, they work the same. The primary difference is that if you pass no value to 'underscore', it returns null, while 'trans' returns a translator instance, which can be helpful in certain scenarios.

How should one handle large translation files to avoid issues?

To avoid issues with large translation files, it's important to carefully name keys, organize them logically, and be cautious of file size to prevent them from becoming overwhelming or disorganized.