Konwencja plików językowych, Nazwy kluczy Opcje

[markonix]

Jakiej konwencji używacie jeżeli chodzi o aplikacje multi-języczne na prostych plikach językowych (tablice)? Np. Laravel.

PHPSTORM fajnie podpowiada użyte indeksy więc warto trzymać się jakiegoś standardu, a nie potrafię wybrać najlepszego, a teraz na dodatek muszę przepisać 10% plików językowych bo nie można użyć czegoś takiego:

[PHP] pobierz, plaintext 
'teacher.name' => 'Nauczyciel',
'teacher.name.placeholder' => 'Podaj imię i nazwisko',
[PHP] pobierz, plaintext 

Ponieważ biblioteki które pozwalają na zarządzanie plikami językowymi dumpują potem to wszystko do tablicy i dot notation jest zmienione na zagnieżdżenia. Tak więc spowoduje to nadpisanie i trzeba stosować np.

[PHP] pobierz, plaintext 
'teacher.name.label' => 'Nauczyciel',
'teacher.name.placeholder' => 'Podaj imię i nazwisko',
[PHP] pobierz, plaintext 

To tyle przestrogi, może kiedyś komu zaoszczędzi to czasu, ja teraz mam około 200 linijek CTR+F i CTR+R

Wracając do tematu podzielcie się swoimi konwencjami. Moje przemyślenia:
Na pewno warto nie bać się podziału na pliki. Ja tego żałuje bo teraz gdy pliki mają 2500 linijek to przy edytorach webowych troszkę przymula.
Pliki podzielone na jakieś ogólne, wspólne np. app.php czy system.php oraz na większe moduły (fragmenty systemu).
W samych plikach stosuje podgrupy np.

button.add => Dodaj
button.delete => Usuń

Przy PHPSTORM taka konwencja mega się sprawdza, nie musisz zaglądać do pliku językowej tylko bez problemu na "czuja" zakodujesz widok.

Problem z konwencją mam już przy konkretnym widoku, powiedzmy formularz z nauczycielem.

Plik modules.php

teacher.title => Dodawanie nauczyciela, // Konwencja na tytuł strony, title, text główny?
teacher.form.name.label' => 'Imię',
teacher.form.name.text' => 'Minimum 2 znaki',
teacher.form.name.placeholder' => 'Proszę wprowadzić imię',

Wygląda w porządku, ale już reusable troszkę kuleje, bo wszystkie labele można by użyć w widoku typu "show" czyli profilu nauczyciela.

[PHP] pobierz, plaintext 
<span>{{ __('teacher.form.name.label') }}</span>: {{ $teacher->name }}
[PHP] pobierz, plaintext 

Troszkę to nie pasuje bo to nie formularz, znowu przejrzyściej byłoby dla mnie:

[PHP] pobierz, plaintext 
<span>{{ __('teacher.name') }}</span>: {{ $teacher->name }}
[PHP] pobierz, plaintext 

Wtedy, bez zaglądania w pliki wiem na 99% co jest pod tym tłumaczeniem.

teacher.name i opcjonalne teacher.name.placeholder nie wchodzi w grę, tak właśnie robiłem i teraz żałuje (patrz wyżej).
Ewentualnie teacher.name-placeholder lub name_placeholder. Jaki widzicie w ogóle _ - w nazwach? _ staram się używać wyłącznie jako spacja (dwu wyrazowe zmienne), nigdy w innym celu.

Macie jakieś swoje przemyślenia, może swoje koncepcje? Na stacku nic nie znalazłem, jest dużo o konwencjach nazewnictwa zmiennych, klas czy plików, ale kluczy w plikach językowych nie.

Ten post edytował markonix 14.10.2018, 15:02:29

[Pyton_000]

Zawsze można pisać coś w stylu `__('Nauczyciel');` a potem tylko zrobić translacje do języka innego niż PL dzięki temu masz gotowy fallback po polsku a jeśli jest tłumaczenie EN to je zastosuje.

[markonix]

Wiem ale nie lubię takiego podejścia:
1) pliki językowe mniej czytelnie (json brak komentarzy, bloków itp).
2) nie motywuje do uzupełniania plików językowych
3) storm nic tu nie pomoże
4) biblioteki nie obsługują takich tłumaczeń (bo faktycznie to trudniejsze)
5) wszystko musi być w jednym pliku
6) mniej wygodne np. lubię takie konstrukcje: <button>{{ __('system.button.'. $teacher ? 'edit' : 'create') }}
7) PL w kodzie
8) Jedna mała zmiana (literka, kropka) spowoduje z automatu konieczność edycji wszystkich plików językowych

Ten post edytował markonix 14.10.2018, 16:01:31

[kayman]

mnie najbardzie pasuje takie

[PHP] pobierz, plaintext 
class Lang {
 
    private static $data = [];
    private static $instance;
 
    private function __construct() {
        $filename = ROOTPATH . 'Langs/' . Session::get('lang') . '.php';
        if (file_exists($filename)) {
            self::$data = require $filename;
        }
    }
 
    public static function get($key) {
        if (!isset(self::$instance)) {
            self::$instance = new self();
        }
        if (isset(self::$data[$key])) {
            return self::$data[$key];
        }
        return $key;
    }
 
}
[PHP] pobierz, plaintext 

plik langu pl.php

[PHP] pobierz, plaintext 
return [  
    'Add' => 'Dodaj',
    'Edit' => 'Edytuj',
    'Delete' => 'Usuń'   
    //......    
];
[PHP] pobierz, plaintext 

usage

[PHP] pobierz, plaintext 
echo Lang::get('Delete'); // Usuń
echo Lang::get('Deleted'); //Deleted
[PHP] pobierz, plaintext 

podobne rozwiązanie stosuje Yii, polega ono na przyjęciu defautowego langu np en, potem już jak nie ma klucza w tablicy wyświetla klucz, jest wyświetla tłumaczenie

wianuszki typu teacher.name.label są chyba trudniejsze do ogarnięcia

[markonix]

Ty podałeś konstrukcję systemów plików, a dokładnie jednego pliku, ja piszę tutaj o konwencji nazewnictwa już w tych plikach.

Kilka inspiracji jakie znalazłem:

https://github.com/CachetHQ/Cachet/blob/2.4...ng/en/forms.php (od razu w tablicy, też czytelne i od razu wymusza odpowiednie indeksy w tablicy)

https://stackoverflow.com/questions/2819690...-language-files - tu dokładnie ten temat ale mało informacji.