README

一个基于PHP文件的小型翻译库。

安装

在composer.json内部

{
   "require": {
      "php": ">=8.1",
      "niirrty/niirrty.translation": "~0.6"
   }
}

如何使用

include __DIR__ . '/vendor/autoload.php';

use \Niirrty\Locale\Locale;
use \Niirrty\Translation\Sources\PHPFileSource;
use \Niirrty\Translation\Translator;

try
{
    // Init the locale
    $locale = Locale::Create(
        // The fallback locale if no other was found
        new Locale( 'de', 'de', 'UTF-8' ),
        // Check also the URL path for an locale or language part?
        true,
        // This are the names of the parameters, accepted from $_POST, $_GET and $_SESSION
        [ 'lc', 'locale', 'language', 'lang', 'lng' ]
    );

    // Init the translator instance with defined locale
    $translator = new Translator( $locale );

    // Define the templates source directory. There is also a JSONFileSource and a XMLFileSource
    $translatorSource = new PHPFileSource( __DIR__ . '/translations', $locale );
    // ...and add the source to template engine
    $translator->addSource( $translatorSource );

    // If you want access the Translator instance globally
    $translator->setAsGlobalInstance();

    // Example output
    echo Translator::GetInstance()->read( 'Hello1', 'MyApp', 'Hello people!' ), "\n",
         $translator->read( 'NiceTM', 'MyApp', 'NiceToMeetYouM!' );

}
catch ( \Throwable $ex )
{
    // TODO: Do some error handling
}

翻译源

翻译者必须拥有1个或多个翻译源。每个源定义了一个目录，该目录必须包含所有支持语言的翻译源文件。

翻译文件

• 文件名（不带扩展名）必须是区域名称。例如：de 或 de_AT
• 文件扩展名必须由使用的ISource实现支持。目前已知的有.php（PHPFileSource）、.json（JSONFileSource）和.xml（XMLFileSource）

示例目录结构

+ translations
   - de.php
   - de_DE.php
   - en.php
   - fr_FR.php 

PHP文件源

格式是

<?php

return [
    'Text 1' => 'Ein Beispieltext',
    'Text 2' => 'Ein anderer Beispieltext',
    'weekdaysList' => [ 'Montag', 'Dienstag', 'Mittwoch', 'Donnerstag', 'Freitag', 'Samstag', 'Sonntag' ],
    'weekdaysDict' => [ 'Mo' => 'Montag', 'Di' => 'Dienstag', 'Mi' => 'Mittwoch', 'Do' => 'Donnerstag',
                        'Fr' => 'Freitag', 'Sa' => 'Samstag', 'So' => 'Sonntag' ]
];

JSON文件源

格式是

{
    "Text 1"  : "Ein Beispieltext",
    "Text 2"  : "Ein anderer Beispieltext",
    "weekdaysList": [ "Montag", "Dienstag", "Mittwoch", "Donnerstag", "Freitag", "Samstag", "Sonntag" ],
    "weekdaysDict": { "Mo": "Montag", "Di": "Dienstag", "Mi": "Mittwoch", "Do": "Donnerstag",
                      "Fr": "Freitag", "Sa": "Samstag", "So": "Sonntag" }
}

XML文件源

格式是

<?xml version="1.0" encoding="UTF-8" ?>
<translations>
   <trans id="Text 1" text="Ein Beispieltext" />
   <trans id="Text 2">Ein anderer Beispieltext</trans>
   <trans id="Text 3">
      <text>Ein ganz anderer Beispieltext</text>
   </trans>
   <trans>
      <id>Text 4</id>
      <text>Hallo Welt</text>
   </trans>
   <trans id="weekdaysList">
      <list>
         <item>Montag</item>
         <item>Dienstag</item>
         <item>Mittwoch</item>
         <item>Donnerstag</item>
         <item>Freitag</item>
         <item>Samstag</item>
         <item>Sonntag</item>
      </list>
   </trans>
   <trans>
      <id>weekdaysDict</id>
      <dict>
         <item key="Mo">Montag</item>
         <item key="Di">Dienstag</item>
         <item key="Mi">Mittwoch</item>
         <item key="Do">Donnerstag</item>
         <item key="Fr">Freitag</item>
         <item key="Sa">Samstag</item>
         <item key="So">Sonntag</item>
      </dict>
   </trans>
</translations>