[TASK] XLF core locallang files are still referenced with .php/.xml
[Packages/TYPO3.CMS.git] / typo3 / sysext / reports / Classes / Status.php
index ae6e95e..b2f9667 100644 (file)
@@ -4,7 +4,7 @@ namespace TYPO3\CMS\Reports;
 /***************************************************************
  *  Copyright notice
  *
- *  (c) 2009-2011 Ingo Renner <ingo@typo3.org>
+ *  (c) 2009-2013 Ingo Renner <ingo@typo3.org>
  *  All rights reserved
  *
  *  This script is part of the TYPO3 project. The TYPO3 project is
@@ -27,8 +27,6 @@ namespace TYPO3\CMS\Reports;
  * A class representing a certain status
  *
  * @author Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage reports
  */
 class Status {
 
@@ -58,12 +56,16 @@ class Status {
        protected $severity;
 
        /**
-        * constructor for class tx_reports_report_status_Status
+        * Construct a status
         *
-        * @param string $title The status' title
-        * @param string $value The status' value
-        * @param string $message An optional message further describing the status
-        * @param integer $severity A severity level, one of
+        * All values must be given as constructor arguments.
+        * All strings should be localized.
+        *
+        * @param string $title Status title, eg. "Deprecation log"
+        * @param string $value Status value, eg. "Disabled"
+        * @param string $message Optional message further describing the title/value combination
+        *                      Example:, eg "The deprecation log is imporant and does foo, to disable it do bar"
+        * @param integer $severity A severity level. Use one of the constants above!
         */
        public function __construct($title, $value, $message = '', $severity = self::OK) {
                $this->title = (string) $title;
@@ -122,7 +124,7 @@ class Status {
                        self::ERROR => 'ERR'
                );
                // Max length 80 characters
-               $stringRepresentation = ((str_pad((('[' . $severity[$this->severity]) . ']'), 7) . str_pad($this->title, 40)) . ' - ') . substr($this->value, 0, 30);
+               $stringRepresentation = str_pad(('[' . $severity[$this->severity] . ']'), 7) . str_pad($this->title, 40) . ' - ' . substr($this->value, 0, 30);
                return $stringRepresentation;
        }