[TASK] Clean up t3lib_message_ErrorPageMessage
authorSteffen Gebert <steffen.gebert@typo3.org>
Mon, 8 Aug 2011 16:07:13 +0000 (18:07 +0200)
committerSteffen Gebert <steffen.gebert@typo3.org>
Mon, 5 Sep 2011 20:06:30 +0000 (22:06 +0200)
Change-Id: I598acfa2b2c15b1fb290827504a23462c90b374d
Resolves: #29494
Reviewed-on: http://review.typo3.org/4775
Reviewed-by: Steffen Gebert
Tested-by: Steffen Gebert
t3lib/message/class.t3lib_message_abstractmessage.php
t3lib/message/class.t3lib_message_errorpagemessage.php

index 43306aa..f969e1b 100644 (file)
@@ -30,8 +30,8 @@
 /**
  * A class used for any kind of messages.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @author     Benjamin Mack <benni@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
+ * @author Benjamin Mack <benni@typo3.org>
  * @package TYPO3
  * @subpackage t3lib/message
  */
@@ -67,7 +67,7 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Gets the message's title.
         *
-        * @return      string  The message's title.
+        * @return string The message's title.
         */
        public function getTitle() {
                return $this->title;
@@ -76,8 +76,8 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Sets the message's title
         *
-        * @param       string  The message's title
-        * @return      void
+        * @param string $title The message's title
+        * @return void
         */
        public function setTitle($title) {
                $this->title = (string) $title;
@@ -86,7 +86,7 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Gets the message.
         *
-        * @return      string  The message.
+        * @return string The message.
         */
        public function getMessage() {
                return $this->message;
@@ -95,8 +95,8 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Sets the message
         *
-        * @param       string  The message
-        * @return      void
+        * @param string $message The message
+        * @return void
         */
        public function setMessage($message) {
                $this->message = (string) $message;
@@ -105,9 +105,9 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Gets the message' severity.
         *
-        * @return      integer The message' severity, either of t3lib_message_AbstractMessage::INFO,
-        * t3lib_message_AbstractMessage::OK, t3lib_message_AbstractMessage::WARNING
-        * or t3lib_message_AbstractMessage::ERROR
+        * @return int The message' severity, either of t3lib_message_AbstractMessage::INFO,
+        *     t3lib_message_AbstractMessage::OK, t3lib_message_AbstractMessage::WARNING
+        *     or t3lib_message_AbstractMessage::ERROR
         */
        public function getSeverity() {
                return $this->severity;
@@ -116,10 +116,10 @@ abstract class t3lib_message_AbstractMessage {
        /**
         * Sets the message' severity
         *
-        * @param       string  The severity, must be either of t3lib_message_AbstractMessage::INFO,
-        * t3lib_message_AbstractMessage::OK, t3lib_message_AbstractMessage::WARNING
-        * or t3lib_message_AbstractMessage::ERROR. Default is t3lib_message_AbstractMessage::OK.
-        * @return      void
+        * @param int $severity The severity, must be either of t3lib_message_AbstractMessage::INFO,
+        *     t3lib_message_AbstractMessage::OK, t3lib_message_AbstractMessage::WARNING
+        *     or t3lib_message_AbstractMessage::ERROR. Default is t3lib_message_AbstractMessage::OK.
+        * @return void
         */
        public function setSeverity($severity = self::OK) {
                $this->severity = t3lib_utility_Math::forceIntegerInRange(
@@ -135,7 +135,7 @@ abstract class t3lib_message_AbstractMessage {
         * Creates a string representation of the message. Useful for command
         * line use.
         *
-        * @return      string  A string representation of the message.
+        * @return string A string representation of the message.
         */
        public function __toString() {
                $severities = array(
index 57728d8..8269660 100644 (file)
 class t3lib_message_ErrorpageMessage extends t3lib_message_AbstractMessage {
 
        /**
-        * defines whether the message should be stored in the session
-        * (to survive redirects) or only for one request (default)
+        * Path to the HTML template file
         *
         * @var string
         */
        protected $htmlTemplate;
 
        /**
-        * Constructor for a error message
+        * Constructor for an Error message
         *
-        * @param       string  The message.
-        * @param       string  message title.
-        * @param       integer Optional severity, must be either of t3lib_message_ErrorpageMessage::INFO, t3lib_message_ErrorpageMessage::OK,
-        *                                t3lib_message_ErrorpageMessage::WARNING or t3lib_message_ErrorpageMessage::ERROR. Default is t3lib_message_ErrorpageMessage::ERROR.
-        * @return      void
+        * @param string $message The error message
+        * @param string $title Title of the message, can be empty
+        * @param integer $severity Optional severity, must be either of t3lib_message_AbstractMessage::INFO, t3lib_message_AbstractMessage::OK,
+        *     t3lib_message_AbstractMessage::WARNING or t3lib_message_AbstractMessage::ERROR. Default is t3lib_message_AbstractMessage::ERROR.
         */
-       public function __construct($message, $title, $severity = self::ERROR) {
+       public function __construct($message, $title, $severity = t3lib_message_AbstractMessage::ERROR) {
                $this->htmlTemplate = TYPO3_mainDir . 'sysext/t3skin/templates/errorpage-message.html';
                $this->setMessage($message);
                $this->setTitle(strlen($title) > 0 ? $title : 'Error!');
                $this->setSeverity($severity);
        }
 
-
        /**
         * Gets the filename of the HTML template.
         *
-        * @return      string  The filename of the HTML template.
+        * @return string The filename of the HTML template.
         */
        public function getHtmlTemplate() {
                return $this->htmlTemplate;
@@ -72,8 +69,8 @@ class t3lib_message_ErrorpageMessage extends t3lib_message_AbstractMessage {
        /**
         * Sets the filename to the HTML template
         *
-        * @param       string  The filename to the HTML template.
-        * @return      void
+        * @param string $htmlTemplate The filename of the HTML template.
+        * @return void
         */
        public function setHtmlTemplate($htmlTemplate) {
                $this->htmlTemplate = (string) $htmlTemplate;
@@ -82,7 +79,7 @@ class t3lib_message_ErrorpageMessage extends t3lib_message_AbstractMessage {
        /**
         * Renders the flash message.
         *
-        * @return      string  The flash message as HTML.
+        * @return string The flash message as HTML.
         */
        public function render() {
                $classes = array(
@@ -110,7 +107,7 @@ class t3lib_message_ErrorpageMessage extends t3lib_message_AbstractMessage {
        /**
         * Renders the flash message and echoes it.
         *
-        * @return      void
+        * @return void
         */
        public function output() {
                $content = $this->render();