TranslationHelper¶
\nn\t3::TranslationHelper()¶
Übersetzungsmanagement per Deep-L.
Damit diese Funktion nutzbar ist, muss im Extension-Manager von nnhelpers ein Deep-L Api-Key hinterlegt werden.
Der Key ist ist kostenfrei und erlaubt die Übersetzung von 500.000 Zeichen pro Monat.
// Übersetzer aktivieren
$translationHelper = \nn\t3::injectClass( \Nng\Nnhelpers\Helpers\TranslationHelper::class );
// Übersetzung per Deep-L erlauben
$translationHelper->setEnableApi( true );
// Zielsprache festlegen
$translationHelper->setTargetLanguage( 'EN' );
// Max. Anzahl der Übersetzungen erlauben (zwecks Debugging)
$translationHelper->setMaxTranslations( 2 );
// Pfad, in dem die l18n-Dateien gespeichert / gecached werden sollen
$translationHelper->setL18nFolderpath( 'EXT:nnhelpers/Resources/Private/Language/' );
// Übersetzung starten
$text = $translationHelper->translate('my.example.key', 'Das ist der Text, der übersetzt werden soll');
Overview of Methods¶
\nn\t3::TranslationHelper()->createKeyHash($param = '');¶
Erzeugt einen eindeutigen Hash aus dem Key, der zur Identifizierung eines Textes benötigt wird. Jeder Text hat in allen Sprachen den gleichen Key.
$translationHelper->createKeyHash( '12345' );
$translationHelper->createKeyHash( ['mein', 'key', 'array'] );
@return string\nn\t3::TranslationHelper()->createTextHash($text = '');¶
Erzeugt einen eindeutigen Hash / Checksum aus dem Text. Der übergebene Text ist immer die Basis-Sprache. Ändert sich der Text in der Basissprache, gibt die Methode eine andere Checksum zurück. Dadurch wird erkannt, wann ein Text neu übersetzt werden muss. Reine Änderungen an Whitespaces und Tags werden ignoriert.
$translationHelper->createKeyHash( '12345' );
$translationHelper->createKeyHash( ['mein', 'key', 'array'] );
@return string\nn\t3::TranslationHelper()->getEnableApi();¶
Gibt zurück, ob die API aktiviert ist.
$translationHelper->getEnableApi(); // default: false
@return boolean\nn\t3::TranslationHelper()->getL18nFolderpath();¶
Gibt den aktuellen Ordner zurück, in dem die Übersetzungs-Dateien gecached werden.
Default ist typo3conf/l10n/nnhelpers/
$translationHelper->getL18nFolderpath();
@return string\nn\t3::TranslationHelper()->getL18nPath();¶
Absoluten Pfad zur l18n-Cache-Datei zurückgeben.
Default ist typo3conf/l10n/nnhelpers/[LANG].autotranslated.json
$translationHelper->getL18nPath();
@return string\nn\t3::TranslationHelper()->getMaxTranslations();¶
Holt die maximale Anzahl an Übersetzungen, die pro Instanz gemacht werden sollen.
$translationHelper->getMaxTranslations(); // default: 0 = unendlich
@return integer\nn\t3::TranslationHelper()->getTargetLanguage();¶
Holt die Zielsprache für die Übersetzung
$translationHelper->getTargetLanguage(); // Default: EN
@return string\nn\t3::TranslationHelper()->loadL18nData();¶
Komplette Sprach-Datei laden.
$translationHelper->loadL18nData();
@return array\nn\t3::TranslationHelper()->saveL18nData($data = []);¶
Komplette Sprach-Datei speichern
$translationHelper->saveL18nData( $data );
@return boolean\nn\t3::TranslationHelper()->setEnableApi($enableApi);¶
Aktiviert / Deaktiviert die Übersetzung per Deep-L.
$translationHelper->setEnableApi( true ); // default: false
@param boolean $enableApi@return self\nn\t3::TranslationHelper()->setL18nFolderpath($l18nFolderpath);¶
Setzt den aktuellen Ordner, in dem die Übersetzungs-Dateien gecached werden. Idee ist es, die übersetzten Texte für Backend-Module nur 1x zu übersetzen und dann in dem Extension-Ordner zu speichern. Von dort werden sie dann ins GIT deployed.
Default ist typo3conf/l10n/nnhelpers/
$translationHelper->setL18nFolderpath('EXT:myext/Resources/Private/Language/');
@return self\nn\t3::TranslationHelper()->setMaxTranslations($maxTranslations);¶
Setzt die maximale Anzahl an Übersetzungen, die pro Instanz gemacht werden sollen. Hilft beim Debuggen (damit das Deep-L Kontingent nicht durch Testings ausgeschöpft wird) und bei TimeOuts, wenn viele Texte übersetzt werden müssen.
$translationHelper->setMaxTranslations( 5 ); // Nach 5 Übersetzungen abbrechen
@param $maxTranslations@return self\nn\t3::TranslationHelper()->setTargetLanguage($targetLanguage);¶
Setzt die Zielsprache für die Übersetzung
$translationHelper->setTargetLanguage( 'FR' );
@param string $targetLanguage Zielsprache der Übersetzung@return self\nn\t3::TranslationHelper()->translate($key, $text = '');¶
Übersetzen eines Textes.
$translationHelper = \nn\t3::injectClass( \Nng\Nnhelpers\Helpers\TranslationHelper::class );
$translationHelper->setEnableApi( true );
$translationHelper->setTargetLanguage( 'EN' );
$text = $translationHelper->translate('my.example.key', 'Das ist der Text, der übersetzt werden soll');
@return string