Added feature #15989: Create a new abstract class t3lib_message_abstractmessage
authorBenni Mack <benni.mack@typo3.org>
Fri, 15 Oct 2010 09:48:53 +0000 (09:48 +0000)
committerBenni Mack <benni.mack@typo3.org>
Fri, 15 Oct 2010 09:48:53 +0000 (09:48 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@9067 709f56b5-9817-0410-a4d7-c38de5d9e867

ChangeLog
t3lib/class.t3lib_flashmessage.php
t3lib/core_autoload.php
t3lib/message/class.t3lib_message_abstractmessage.php [new file with mode: 0644]

index 7635ba6..64ff1dd 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2010-10-15  Benjamin Mack  <benni@typo3.org>
+
+       * Added feature #15989: Create a new abstract class t3lib_message_abstractmessage
+
 2010-10-15 Steffen Kamper  <steffen@typo3.org>
 
        * Fixed bug #15993: Bug: Felogin shouldn't show the permalogin form controls when permalogin is set to "forced on" in install tool
index bef576c..ec91ccc 100644 (file)
  * @package TYPO3
  * @subpackage t3lib
  */
-class t3lib_FlashMessage {
-
-       const NOTICE  = -2;
-       const INFO    = -1;
-       const OK      = 0;
-       const WARNING = 1;
-       const ERROR   = 2;
-
-       /**
-        * The message's title
-        *
-        * @var string
-        */
-       protected $title = '';
-
-       /**
-        * The message
-        *
-        * @var string
-        */
-       protected $message = '';
-
-       /**
-        * The message's severity
-        *
-        * @var integer
-        */
-       protected $severity = self::OK;
+class t3lib_FlashMessage extends t3lib_message_AbstractMessage {
 
        /**
         * defines whether the message should be stored in the session (to survive redirects) or only for one request (default)
@@ -86,25 +59,6 @@ class t3lib_FlashMessage {
                $this->setStoreInSession($storeInSession);
        }
 
-       /**
-        * Gets the message's title.
-        *
-        * @return      string  The message's title.
-        */
-       public function getTitle() {
-               return $this->title;
-       }
-
-       /**
-        * Sets the message's title
-        *
-        * @param       string  The message's title
-        * @return      void
-        */
-       public function setTitle($title) {
-               $this->title = (string) $title;
-       }
-
 
        /**
         * Gets the message's storeInSession flag.
@@ -125,50 +79,6 @@ class t3lib_FlashMessage {
                $this->storeInSession = (bool) $storeInSession;
        }
 
-
-       /**
-        * Gets the message.
-        *
-        * @return      string  The message.
-        */
-       public function getMessage() {
-               return $this->message;
-       }
-
-       /**
-        * Sets the message
-        *
-        * @param       string  The message
-        * @return      void
-        */
-       public function setMessage($message) {
-               $this->message = (string) $message;
-       }
-
-       /**
-        * Gets the message' severity.
-        *
-        * @return      integer The message' severity, either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR
-        */
-       public function getSeverity() {
-               return $this->severity;
-       }
-
-       /**
-        * Sets the message' severity
-        *
-        * @param       string  The severity, must be either of t3lib_FlashMessage::INFO, t3lib_FlashMessage::OK, t3lib_FlashMessage::WARNING or t3lib_FlashMessage::ERROR. Default is t3lib_FlashMessage::OK.
-        * @return      void
-        */
-       public function setSeverity($severity = self::OK) {
-               $this->severity = t3lib_div::intInRange(
-                       $severity,
-                       self::NOTICE, // minimum
-                       self::ERROR, // maximum
-                       self::OK // default if out of bounds
-               );
-       }
-
        /**
         * Renders the flash message.
         *
@@ -176,11 +86,11 @@ class t3lib_FlashMessage {
         */
        public function render() {
                $classes = array(
-                       t3lib_FlashMessage::NOTICE  => 'notice',
-                       t3lib_FlashMessage::INFO    => 'information',
-                       t3lib_FlashMessage::OK      => 'ok',
-                       t3lib_FlashMessage::WARNING => 'warning',
-                       t3lib_FlashMessage::ERROR   => 'error',
+                       self::NOTICE  => 'notice',
+                       self::INFO    => 'information',
+                       self::OK      => 'ok',
+                       self::WARNING => 'warning',
+                       self::ERROR   => 'error',
                );
 
                $title = '';
@@ -196,29 +106,6 @@ class t3lib_FlashMessage {
                return $message;
        }
 
-
-       /**
-        * Creates a string representation of the flash message. Useful for command
-        * line use.
-        *
-        * @return      string  A string representation of the flash message.
-        */
-       public function __toString() {
-               $severities = array(
-                       t3lib_FlashMessage::INFO    => 'INFO',
-                       t3lib_FlashMessage::OK      => 'OK',
-                       t3lib_FlashMessage::WARNING => 'WARNING',
-                       t3lib_FlashMessage::ERROR   => 'ERROR',
-               );
-
-               $title = '';
-               if (!empty($this->title)) {
-                       $title = ' - ' . $this->title;
-               }
-
-               return $severities[$this->severity] . $title . ': ' . $this->message;
-       }
-
 }
 
 
index 268da7f..ce544e4 100644 (file)
@@ -42,6 +42,7 @@ $t3libClasses = array(
        't3lib_loadmodules' => PATH_t3lib . 'class.t3lib_loadmodules.php',
        't3lib_lock' => PATH_t3lib . 'class.t3lib_lock.php',
        't3lib_matchcondition' => PATH_t3lib . 'class.t3lib_matchcondition.php',
+       't3lib_message_abstractmessage' => PATH_t3lib . 'message/class.t3lib_message_abstractmessage.php',
        't3lib_modsettings' => PATH_t3lib . 'class.t3lib_modsettings.php',
        't3lib_pageselect' => PATH_t3lib . 'class.t3lib_page.php',
        't3lib_pagerenderer' => PATH_t3lib . 'class.t3lib_pagerenderer.php',
@@ -144,4 +145,4 @@ $t3libClasses = array(
 $tslibClasses = require(PATH_typo3 . 'sysext/cms/ext_autoload.php');
 
 return array_merge($t3libClasses, $tslibClasses);
-?>
\ No newline at end of file
+?>
diff --git a/t3lib/message/class.t3lib_message_abstractmessage.php b/t3lib/message/class.t3lib_message_abstractmessage.php
new file mode 100644 (file)
index 0000000..2c75864
--- /dev/null
@@ -0,0 +1,163 @@
+<?php
+/***************************************************************
+*  Copyright notice
+*
+*  (c) 2009-2010 Ingo Renner <ingo@typo3.org>
+*  (c) 2010 Benjamin Mack <benni@typo3.org>
+*  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.
+*  A copy is found in the textfile GPL.txt and important notices to the license
+*  from the author is found in LICENSE.txt distributed with these scripts.
+*
+*
+*  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!
+***************************************************************/
+
+
+/**
+ * A class used for any kind of messages.
+ *
+ * @author     Ingo Renner <ingo@typo3.org>
+ * @author     Benjamin Mack <benni@typo3.org>
+ * @package TYPO3
+ * @subpackage t3lib/message
+ */
+abstract class t3lib_message_AbstractMessage {
+
+       const NOTICE  = -2;
+       const INFO    = -1;
+       const OK      = 0;
+       const WARNING = 1;
+       const ERROR   = 2;
+
+       /**
+        * The message's title
+        *
+        * @var string
+        */
+       protected $title = '';
+
+       /**
+        * The message
+        *
+        * @var string
+        */
+       protected $message = '';
+
+       /**
+        * The message's severity
+        *
+        * @var integer
+        */
+       protected $severity = self::OK;
+
+       /**
+        * Gets the message's title.
+        *
+        * @return      string  The message's title.
+        */
+       public function getTitle() {
+               return $this->title;
+       }
+
+       /**
+        * Sets the message's title
+        *
+        * @param       string  The message's title
+        * @return      void
+        */
+       public function setTitle($title) {
+               $this->title = (string) $title;
+       }
+
+       /**
+        * Gets the message.
+        *
+        * @return      string  The message.
+        */
+       public function getMessage() {
+               return $this->message;
+       }
+
+       /**
+        * Sets the message
+        *
+        * @param       string  The message
+        * @return      void
+        */
+       public function setMessage($message) {
+               $this->message = (string) $message;
+       }
+
+       /**
+        * 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
+        */
+       public function getSeverity() {
+               return $this->severity;
+       }
+
+       /**
+        * 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
+        */
+       public function setSeverity($severity = self::OK) {
+               $this->severity = t3lib_div::intInRange(
+                       $severity,
+                       self::NOTICE, // minimum
+                       self::ERROR, // maximum
+                       self::OK // default if out of bounds
+               );
+       }
+
+
+       /**
+        * Creates a string representation of the message. Useful for command
+        * line use.
+        *
+        * @return      string  A string representation of the message.
+        */
+       public function __toString() {
+               $severities = array(
+                       self::INFO    => 'INFO',
+                       self::OK      => 'OK',
+                       self::WARNING => 'WARNING',
+                       self::ERROR   => 'ERROR',
+               );
+
+               $title = '';
+               if (!empty($this->title)) {
+                       $title = ' - ' . $this->title;
+               }
+
+               return $severities[$this->severity] . $title . ': ' . $this->message;
+       }
+
+}
+
+
+if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/message/class.t3lib_message_abstractmessage.php'])  {
+       include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/message/class.t3lib_message_abstractmessage.php']);
+}
+
+?>
\ No newline at end of file