[FEATURE] New ViewHelper which gets all translations from a certain language file

Classes/ViewHelpers/Resource/LanguageViewHelper.php

@@ -0,0 +1,203 @@
+<?php
+namespace FluidTYPO3\Vhs\ViewHelpers\Resource;
+
+/***************************************************************
+ *  Copyright notice
+ *
+ *  (c) 2015 Cornel Boppart <[email protected]>
+ *
+ *  All rights reserved
+ *
+ *  This script is part of the TYPO3 project. The TYPO3 project is
+ *  free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  The GNU General Public License can be found at
+ *  http://www.gnu.org/copyleft/gpl.html.
+ *
+ *  This script is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  This copyright notice MUST APPEAR in all copies of the script!
+ ***************************************************************/
+
+use \FluidTYPO3\Vhs\Utility\ViewHelperUtility;
+use \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
+use \TYPO3\CMS\Fluid\Core\ViewHelper\Exception;
+use \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
+use \TYPO3\CMS\Core\Utility\GeneralUtility;
+use \TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
+
+/**
+ * Resource: Language
+ *
+ * Reads a certain language file with returning not just one single label,
+ * but all the translated labels.
+ *
+ * ### Examples
+ *
+ *    <!-- Tag usage for force getting labels in a specific language (different to current is possible too) -->
+ *    <v:resource.language extensionName="myext" path="Path/To/Locallang.xlf" languageKey="en"/>
+ *
+ *    <!-- Tag usage for getting labels of current language -->
+ *    <v:resource.language extensionName="myext" path="Path/To/Locallang.xlf"/>
+ *
+ * @author Cornel Boppart <[email protected]>
+ * @package Vhs
+ * @subpackage ViewHelpers\Resource
+ */
+class LanguageViewHelper extends AbstractViewHelper {
+
+	const LOCALLANG_DEFAULT = 'locallang.xlf';
+
+	/**
+	 * Registers all arguments for this ViewHelper.
+	 *
+	 * @return void
+	 */
+	public function initializeArguments() {
+		$this->registerArgument('extensionName', 'string', 'Name of the extension', FALSE, NULL);
+		$this->registerArgument('path', 'string', 'Absolute or relative path to the locallang file', FALSE, self::LOCALLANG_DEFAULT);
+		$this->registerArgument('languageKey', 'string', 'Key for getting translation of a different than current initialized language', FALSE, NULL);
+		$this->registerArgument('as', 'string', 'If specified, a template variable with this name containing the requested data will be inserted instead of returning it.', FALSE, NULL);
+	}
+
+	/**
+	 * The main render method of this ViewHelper.
+	 *
+	 * @return array|string
+	 */
+	public function render() {
+		$as = $this->arguments['as'];
+		$path = $this->getResolvedPath();
+
+		$languageKey = $this->getLanguageKey();
+		$locallang = GeneralUtility::readLLfile($path, $languageKey);
+		$labels = $this->getLabelsByLanguageKey($locallang, $languageKey);
+		$labels = $this->getLabelsFromTarget($labels);
+
+		if (TRUE === empty($as)) {
+			return $labels;
+		}
+
+		$labelsAs = ViewHelperUtility::renderChildrenWithVariables($this, $this->templateVariableContainer, array($as => $labels));
+
+		return $labelsAs;
+	}
+
+	/**
+	 * Gets the extension name from defined argument or
+	 * tries to resolve it from the controller context if not set.
+	 *
+	 * @return string
+	 * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception
+	 */
+	protected function getResolvedExtensionName() {
+		$extensionName = $this->arguments['extensionName'];
+
+		if ((NULL === $extensionName) && (TRUE === $this->controllerContext instanceof ControllerContext)) {
+			$request = $this->controllerContext->getRequest();
+			$extensionName = $request->getControllerExtensionName();
+		}
+
+		if (TRUE === empty($extensionName)) {
+			throw new Exception('Unable to read extension name from ControllerContext and value not manually specified');
+		}
+
+		return $extensionName;
+	}
+
+	/**
+	 * Gets the resolved file path with trying to resolve relative paths even if no
+	 * extension key is defined.
+	 *
+	 * @return string
+	 */
+	protected function getResolvedPath() {
+		$path = $this->arguments['path'];
+		$absoluteFileName = GeneralUtility::getFileAbsFileName($this->arguments['path']);
+
+		if (FALSE === file_exists($absoluteFileName)) {
+			$extensionName = $this->getResolvedExtensionName();
+			$extensionKey = GeneralUtility::camelCaseToLowerCaseUnderscored($extensionName);
+			$absoluteFileName = ExtensionManagementUtility::extPath($extensionKey, $path);
+		}
+
+		return $absoluteFileName;
+	}
+
+	/**
+	 * Gets the translated labels by a specific language key
+	 * or fallback to 'default'.
+	 *
+	 * @param array $locallang
+	 * @param string $languageKey
+	 * @return array
+	 */
+	protected function getLabelsByLanguageKey($locallang, $languageKey) {
+		$labels = array();
+
+		if (FALSE === empty($locallang[$languageKey])) {
+			$labels = $locallang[$languageKey];
+		} elseif (FALSE === empty($locallang['default'])) {
+			$labels = $locallang['default'];
+		}
+
+		return $labels;
+	}
+
+	/**
+	 * Simplify label array with just taking the value from target.
+	 *
+	 * @param array $labels
+	 * @return array
+	 */
+	protected function getLabelsFromTarget($labels) {
+		if (TRUE === is_array($labels)) {
+			foreach ($labels as $labelKey => $label) {
+				$labels[$labelKey] = $label[0]['target'];
+			}
+		}
+
+		return $labels;
+	}
+
+	/**
+	 * Gets the language key from arguments or from current
+	 * initialized language if argument is not defined.
+	 *
+	 * @return string
+	 */
+	protected function getLanguageKey() {
+		$languageKey = $this->arguments['languageKey'];
+
+		if (NULL === $languageKey) {
+			$languageKey = $this->getInitializedLanguage();
+		}
+
+		return $languageKey;
+	}
+
+	/**
+	 * Gets the key of current initialized language
+	 * or fallback to 'default'.
+	 *
+	 * @return string
+	 */
+	protected function getInitializedLanguage() {
+		$language = 'default';
+
+		if ('FE' === TYPO3_MODE) {
+			$language = $GLOBALS['TSFE']->lang;
+		} elseif (TRUE === is_object($GLOBALS['LANG'])) {
+			$language = $GLOBALS['LANG']->lang;
+		}
+
+		return $language;
+	}
+
+}

Tests/Unit/ViewHelpers/Resource/LanguageViewHelperTest.php

@@ -0,0 +1,37 @@
+<?php
+namespace FluidTYPO3\Vhs\ViewHelpers\Resource;
+
+/***************************************************************
+ *  Copyright notice
+ *
+ *  (c) 2015 Cornel Boppart <[email protected]>
+ *
+ *  All rights reserved
+ *
+ *  This script is part of the TYPO3 project. The TYPO3 project is
+ *  free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  The GNU General Public License can be found at
+ *  http://www.gnu.org/copyleft/gpl.html.
+ *
+ *  This script is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  This copyright notice MUST APPEAR in all copies of the script!
+ * ************************************************************* */
+
+use \FluidTYPO3\Vhs\ViewHelpers\AbstractViewHelperTest;
+
+/**
+ * @protection off
+ * @author Cornel Boppart <[email protected]>
+ * @package Vhs
+ */
+class LanguageViewHelperTest extends AbstractViewHelperTest {
+
+}