[TASK] Clean up the phpDoc of t3lib/l10n/
authorWouter Wolters <typo3@wouterwolters.nl>
Wed, 30 May 2012 16:46:28 +0000 (18:46 +0200)
committerGeorg Ringer <mail@ringerge.org>
Fri, 1 Jun 2012 13:46:27 +0000 (15:46 +0200)
Clean up the phpDoc of t3lib/l10n/

So I made a patch doing mostly:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)
* CGLify method signatures (the first line of the method)

Change-Id: I2bbdeab574f7c2a4e8595e2dc872a4dff182228c
Resolves: #37616
Releases: 6.0
Reviewed-on: http://review.typo3.org/11743
Reviewed-by: Oliver Klee
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
t3lib/l10n/class.t3lib_l10n_factory.php
t3lib/l10n/class.t3lib_l10n_locales.php
t3lib/l10n/class.t3lib_l10n_store.php
t3lib/l10n/exception/class.t3lib_l10n_exception_filenotfound.php
t3lib/l10n/exception/class.t3lib_l10n_exception_invalidparser.php
t3lib/l10n/exception/class.t3lib_l10n_exception_invalidxmlfile.php
t3lib/l10n/interfaces/interface.t3lib_l10n_parser.php
t3lib/l10n/parser/class.t3lib_l10n_parser_abstractxml.php
t3lib/l10n/parser/class.t3lib_l10n_parser_llphp.php
t3lib/l10n/parser/class.t3lib_l10n_parser_llxml.php
t3lib/l10n/parser/class.t3lib_l10n_parser_xliff.php

index b41b5c3..d67c254 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Provides a language parser factory.
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_Factory implements t3lib_Singleton {
 
@@ -56,6 +56,11 @@ class t3lib_l10n_Factory implements t3lib_Singleton {
                $this->initialize();
        }
 
+       /**
+        * Initialize
+        *
+        * @return void
+        */
        protected function initialize() {
                $this->store = t3lib_div::makeInstance('t3lib_l10n_Store');
 
@@ -77,9 +82,9 @@ class t3lib_l10n_Factory implements t3lib_Singleton {
         * @param string $fileReference Input is a file-reference (see t3lib_div::getFileAbsFileName). That file is expected to be a supported locallang file format
         * @param string $languageKey Language key
         * @param string $charset Character set (option); if not set, determined by the language key
-        * @param int $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception$
-        * @param bool $isLocalizationOverride TRUE if $fileReference is a localization override
-        * @return array|bool
+        * @param integer $errorMode Error mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception$
+        * @param boolean $isLocalizationOverride TRUE if $fileReference is a localization override
+        * @return array|boolean
         */
        public function getParsedData($fileReference, $languageKey, $charset, $errorMode, $isLocalizationOverride = FALSE) {
                try {
index 8656dc3..aa49343 100644 (file)
  *
  * Defining backend system languages
  * When adding new keys, remember to:
- *             - Add character encoding for lang. key in t3lib/class.t3lib_cs.php (default for new languages is "utf-8")
- *             - Add mappings for language in t3lib/class.t3lib_cs.php (TYPO3/ISO, language/script, script/charset)
+ *             - Add character encoding for lang. key in t3lib/class.t3lib_cs.php
+ *              (default for new languages is "utf-8")
+ *             - Add mappings for language in t3lib/class.t3lib_cs.php (TYPO3/ISO,
+ *                     language/script, script/charset)
  *             - Update 'setup' extension labels (sysext/setup/mod/locallang.xlf)
  * That's it!
  *
- * @package    Core
- * @subpackage t3lib
- * @author     Xavier Perseguers <typo3@perseguers.ch>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Xavier Perseguers <typo3@perseguers.ch>
  */
 class t3lib_l10n_Locales implements t3lib_Singleton {
 
@@ -147,7 +149,6 @@ class t3lib_l10n_Locales implements t3lib_Singleton {
        /**
         * Initializes the languages.
         *
-        * @static
         * @return void
         */
        public static function initialize() {
index ecb1931..57a7d84 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Language store.
  *
- * @package    Core
- * @subpackage t3lib
- * @author     Dominique Feyer <dominique.feyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dominique.feyer@reelpeek.net>
  */
 class t3lib_l10n_Store implements t3lib_Singleton {
 
@@ -83,7 +83,7 @@ class t3lib_l10n_Store implements t3lib_Singleton {
         *
         * @param string $fileReference File reference
         * @param string $languageKey Valid language key
-        * @return bool
+        * @return boolean
         */
        public function hasData($fileReference, $languageKey) {
                if (isset($this->data[$fileReference][$languageKey]) && is_array($this->data[$fileReference][$languageKey])) {
@@ -121,7 +121,7 @@ class t3lib_l10n_Store implements t3lib_Singleton {
         *
         * @param string $fileReference File reference
         * @param string $languageKey Valid language key
-        * @param $data
+        * @param array $data
         * @return t3lib_l10n_Store This instance to allow method chaining
         */
        public function setData($fileReference, $languageKey, $data) {
@@ -143,11 +143,11 @@ class t3lib_l10n_Store implements t3lib_Singleton {
        /**
         * Checks file reference configuration (charset, extension, ...).
         *
-        * @throws t3lib_l10n_exception_InvalidParser|t3lib_l10n_exception_FileNotFound
         * @param string $fileReference File reference
         * @param string $languageKey Valid language key
         * @param string $charset Rendering charset
         * @return t3lib_l10n_Store This instance to allow method chaining
+        * @throws t3lib_l10n_exception_InvalidParser|t3lib_l10n_exception_FileNotFound
         */
        public function setConfiguration($fileReference, $languageKey, $charset) {
                $this->configuration[$fileReference] = array(
@@ -212,9 +212,9 @@ class t3lib_l10n_Store implements t3lib_Singleton {
        /**
         * Returns the correct parser for a specific file reference.
         *
-        * @throws t3lib_l10n_exception_InvalidParser
-        * @param string $fileReference File reference
+        * @param string $fileReference File reference
         * @return t3lib_l10n_parser
+        * @throws t3lib_l10n_exception_InvalidParser
         */
        public function getParserInstance($fileReference) {
                if (isset($this->configuration[$fileReference]['parserClass']) && trim($this->configuration[$fileReference]['parserClass']) !== '') {
@@ -230,9 +230,9 @@ class t3lib_l10n_Store implements t3lib_Singleton {
        /**
         * Gets the absolute file path.
         *
-        * @throws InvalidArgumentException
         * @param string $fileReference
         * @return string
+        * @throws InvalidArgumentException
         */
        public function getAbsoluteFileReference($fileReference) {
                if (isset($this->configuration[$fileReference]['fileReference']) && trim($this->configuration[$fileReference]['fileReference']) !== '') {
index 94366cb..08952a1 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * File not found exception
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_exception_FileNotFound extends RuntimeException {
 
index be7c1bf..bd89d2d 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Invalid Parser exception
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_exception_InvalidParser extends RuntimeException {
 
index 425d143..df98680 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Invalid XML file exception
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_exception_InvalidXmlFile extends RuntimeException {
 
index 830d446..1e8a037 100644 (file)
@@ -29,8 +29,8 @@
  * Parser interface.
  *
  * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 interface t3lib_l10n_parser {
 
index 5239585..99ae4b7 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Abstract class for XML based parser.
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 abstract class t3lib_l10n_parser_AbstractXml implements t3lib_l10n_parser {
 
@@ -52,11 +52,11 @@ abstract class t3lib_l10n_parser_AbstractXml implements t3lib_l10n_parser {
        /**
         * Returns parsed representation of XML file.
         *
-        * @throws t3lib_l10n_exception_FileNotFound
         * @param string $sourcePath Source file path
         * @param string $languageKey Language key
         * @param string $charset File charset
         * @return array
+        * @throws t3lib_l10n_exception_FileNotFound
         */
        public function getParsedData($sourcePath, $languageKey, $charset = '') {
                $this->sourcePath = $sourcePath;
@@ -117,8 +117,8 @@ abstract class t3lib_l10n_parser_AbstractXml implements t3lib_l10n_parser {
        /**
         * Loads the current XML file before processing.
         *
-        * @throws t3lib_l10n_exception_InvalidXmlFile
         * @return array An array representing parsed XML file (structure depends on concrete parser)
+        * @throws t3lib_l10n_exception_InvalidXmlFile
         */
        protected function parseXmlFile() {
                $rootXmlNode = simplexml_load_file($this->sourcePath, 'SimpleXmlElement', \LIBXML_NOWARNING);
@@ -136,7 +136,6 @@ abstract class t3lib_l10n_parser_AbstractXml implements t3lib_l10n_parser {
        /**
         * Returns array representation of XML data, starting from a root node.
         *
-        * @abstract
         * @param SimpleXMLElement $root A root node
         * @return array An array representing the parsed XML file
         */
index 4815740..05a4805 100644 (file)
 /**
  * Parser for PHP locallang array.
  *
- * @package    TYPO3
- * @subpackage t3lib
+ * @package TYPO3
+ * @subpackage t3lib
  * @author Dominique Feyer <dfeyer@reelpeek.net>
  * @author Dmitry Dulepov <dmitry.dulepov@gmail.com>
  */
 class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
 
-       /** @var string */
+       /**
+        * @var string
+        */
        protected $cacheFileName;
 
-       /** @var t3lib_cs */
+       /**
+        * @var t3lib_cs
+        */
        protected $csConvObj;
 
-       /** @var string */
+       /**
+        * @var string
+        */
        protected $hashSource;
 
-       /** @var string */
+       /**
+        * @var string
+        */
        protected $sourceCharset;
 
-       /** @var string */
+       /**
+        * @var string
+        */
        protected $targetCharset;
 
        /**
@@ -62,11 +72,11 @@ class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
        /**
         * Returns parsed representation of PHP locallang file.
         *
-        * @throws RuntimeException
         * @param string $sourcePath Source file path
         * @param string $languageKey Language key
         * @param string $charset Charset
         * @return array
+        * @throws RuntimeException
         */
        public function getParsedData($sourcePath, $languageKey, $charset = '') {
                $this->validateParameters($sourcePath, $languageKey);
@@ -120,10 +130,10 @@ class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
        /**
         * Generates the cache file.
         *
-        * @throws RuntimeException
         * @param string $sourcePath
         * @param string $languageKey
         * @return array
+        * @throws RuntimeException
         */
        protected function generateCacheFile($sourcePath, $languageKey) {
                $LOCAL_LANG = array();
@@ -154,7 +164,7 @@ class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
                        unset($labelValue);
                }
 
-               // Cache the content now:
+                       // Cache the content now:
                $serContent = array('origFile' => $this->hashSource, 'LOCAL_LANG' => array('default' => $LOCAL_LANG['default'], $languageKey => $LOCAL_LANG[$languageKey]));
                $res = t3lib_div::writeFileToTypo3tempDir($this->cacheFileName, serialize($serContent));
                if ($res) {
@@ -196,7 +206,7 @@ class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
         * Checks if the file is within the web root.
         *
         * @param string $fileName
-        * @return bool
+        * @return boolean
         */
        protected function isWithinWebRoot($fileName) {
                return (bool)t3lib_div::getFileAbsFileName($fileName);
@@ -222,10 +232,10 @@ class t3lib_l10n_parser_Llphp implements t3lib_l10n_parser {
        /**
         * Validates parameters for the function.
         *
-        * @throws RuntimeException
         * @param string $sourcePath
         * @param string $languageKey
         * @return void
+        * @throws RuntimeException
         */
        protected function validateParameters($sourcePath, $languageKey) {
                if (!$this->isWithinWebRoot($sourcePath) || !@is_file($sourcePath) || !$languageKey) {
index 101d08c..c68f47f 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Parser for XML locallang file.
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_parser_Llxml extends t3lib_l10n_parser_AbstractXml {
 
@@ -169,9 +169,9 @@ class t3lib_l10n_parser_Llxml extends t3lib_l10n_parser_AbstractXml {
        /**
         * Reads and parses XML file and returns internal representation of data.
         *
-        * @throws t3lib_l10n_exception_InvalidXmlFile
         * @param string $targetPath Path of the target file
         * @return array
+        * @throws t3lib_l10n_exception_InvalidXmlFile
         */
        protected function parseXmlTargetFile($targetPath) {
                $rootXmlNode = FALSE;
index bae82c3..f85f9e3 100644 (file)
@@ -28,9 +28,9 @@
 /**
  * Parser for XLIFF file.
  *
- * @package    TYPO3
- * @subpackage t3lib
- * @author     Dominique Feyer <dfeyer@reelpeek.net>
+ * @package TYPO3
+ * @subpackage t3lib
+ * @author Dominique Feyer <dfeyer@reelpeek.net>
  */
 class t3lib_l10n_parser_Xliff extends t3lib_l10n_parser_AbstractXml {