Last active
December 12, 2015 02:58
-
-
Save khuppenbauer/4702897 to your computer and use it in GitHub Desktop.
Translation fallback for elements in TYPO3 Flow
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| namespace Your\Package\ViewHelpers; | |
| /* * | |
| * This script belongs to the TYPO3 Flow package "Fluid". * | |
| * * | |
| * It is free software; you can redistribute it and/or modify it under * | |
| * the terms of the GNU Lesser General Public License, either version 3 * | |
| * of the License, or (at your option) any later version. * | |
| * * | |
| * The TYPO3 project - inspiring people to share! * | |
| * */ | |
| use TYPO3\Flow\Annotations as Flow; | |
| /** | |
| * Returns translated message using source message or key ID. | |
| * | |
| * Also replaces all placeholders with formatted versions of provided values. | |
| * | |
| * = Examples = | |
| * | |
| * <code title="Translation by id"> | |
| * <f:translate id="user.unregistered">Unregistered User</f:translate> | |
| * </code> | |
| * <output> | |
| * translation of label with the id "user.unregistered" and a fallback to "Unregistered User" | |
| * </output> | |
| * | |
| * <code title="Inline notation"> | |
| * {f:translate(id: 'some.label.id', default: 'fallback result')} | |
| * </code> | |
| * <output> | |
| * translation of label with the id "some.label.id" and a fallback to "fallback result" | |
| * </output> | |
| * | |
| * <code title="Custom source and locale"> | |
| * <f:translate id="some.label.id" somesource="SomeLabelsCatalog" locale="de_DE"/> | |
| * </code> | |
| * <output> | |
| * translation from custom source "SomeLabelsCatalog" for locale "de_DE" | |
| * </output> | |
| * | |
| * <code title="Custom source from other package"> | |
| * <f:translate id="some.label.id" source="LabelsCatalog" package="OtherPackage"/> | |
| * </code> | |
| * <output> | |
| * translation from custom source "LabelsCatalog" in "OtherPackage" | |
| * </output> | |
| * | |
| * <code title="Arguments"> | |
| * <f:translate arguments="{0: 'foo', 1: '99.9'}">Untranslated {0} and {1,number}</f:translate> | |
| * </code> | |
| * <output> | |
| * translation of the label "Untranslated foo and 99.9" | |
| * </output> | |
| * | |
| * <code title="Translation by label"> | |
| * <f:translate>Untranslated label</f:translate> | |
| * </code> | |
| * <output> | |
| * translation of the label "Untranslated label" | |
| * </output> | |
| * | |
| */ | |
| class TranslateViewHelper extends \TYPO3\Fluid\Core\ViewHelper\AbstractViewHelper { | |
| /** | |
| * @var \TYPO3\Flow\I18n\Translator | |
| * @Flow\Inject | |
| */ | |
| protected $translator; | |
| /** | |
| * @var \TYPO3\Flow\I18n\Service | |
| */ | |
| protected $localizationService; | |
| /** | |
| * @param \TYPO3\Flow\I18n\Service $localizationService | |
| * @return void | |
| */ | |
| public function injectLocalizationService(\TYPO3\Flow\I18n\Service $localizationService) { | |
| $this->localizationService = $localizationService; | |
| } | |
| /** | |
| * Renders the translated label. | |
| * | |
| * Replaces all placeholders with corresponding values if they exist in the | |
| * translated label. | |
| * | |
| * @param string $id Id to use for finding translation (trans-unit id in XLIFF) | |
| * @param string $value If $key is not specified or could not be resolved, this value is used. If this argument is not set, child nodes will be used to render the default | |
| * @param array $arguments Numerically indexed array of values to be inserted into placeholders | |
| * @param string $source Name of file with translations | |
| * @param string $package Target package key. If not set, the current package key will be used | |
| * @param mixed $quantity A number to find plural form for (float or int), NULL to not use plural forms | |
| * @param string $locale An identifier of locale to use (NULL for use the default locale) | |
| * @return string Translated label or source label / ID key | |
| * @throws \TYPO3\Fluid\Core\ViewHelper\Exception | |
| */ | |
| public function render($id = NULL, $value = NULL, array $arguments = array(), $source = 'Main', $package = NULL, $quantity = NULL, $locale = NULL) { | |
| $localeObject = NULL; | |
| if ($locale !== NULL) { | |
| try { | |
| $localeObject = new \TYPO3\Flow\I18n\Locale($locale); | |
| } catch (\TYPO3\Flow\I18n\Exception\InvalidLocaleIdentifierException $e) { | |
| throw new \TYPO3\Fluid\Core\ViewHelper\Exception('"' . $locale . '" is not a valid locale identifier.' , 1279815885); | |
| } | |
| } else { | |
| $localeObject = $this->localizationService->getConfiguration()->getCurrentLocale(); | |
| } | |
| if ($package === NULL) $package = $this->controllerContext->getRequest()->getControllerPackageKey(); | |
| $originalLabel = $value === NULL ? $this->renderChildren() : $value; | |
| if ($id === NULL) { | |
| $translation = $this->translator->translateByOriginalLabel($originalLabel, $arguments, $quantity, $localeObject, $source, $package); | |
| if ($translation === $originalLabel) { | |
| $localeChain = $this->localizationService->getLocaleChain($localeObject); | |
| $locale = next($localeChain); | |
| if ($locale !== FALSE) { | |
| return $this->render($id, $value, $arguments, $source, $package, $quantity, (string)$locale); | |
| } | |
| } | |
| return $translation; | |
| } else { | |
| $translation = $this->translator->translateById($id, $arguments, $quantity, $localeObject, $source, $package); | |
| if ($translation === $id) { | |
| $localeChain = $this->localizationService->getLocaleChain($localeObject); | |
| $locale = next($localeChain); | |
| if ($locale !== FALSE) { | |
| return $this->render($id, $value, $arguments, $source, $package, $quantity, (string)$locale); | |
| } else { | |
| if ($originalLabel) { | |
| return $this->translator->translateByOriginalLabel($originalLabel, $arguments, $quantity, $localeObject, $source, $package); | |
| } else { | |
| return $id; | |
| } | |
| } | |
| return $translation; | |
| } else { | |
| return $translation; | |
| } | |
| } | |
| } | |
| } | |
| ?> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment