Source for file jMessage.class.php

Documentation is available at jMessage.class.php

  1. <?php
  2. /**
  3. * @package    jelix
  4. * @subpackage utils
  5. * @author     Loic Mathaud
  6. * @copyright  2008 Loic Mathaud
  7. * @link       http://www.jelix.org
  8. * @licence    GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
  9. */
  10.  
  11. /**
  12. * Utility class to log some message in session in order to be displayed in a template
  13. * @package    jelix
  14. * @subpackage utils
  15. * @static
  16. */
  17. class jMessage {
  18.  
  19.     protected static $session_name = 'JELIX_MESSAGE';
  20.     
  21.     
  22.     /**
  23.     * Add a message
  24.     * @param string $message the message
  25.     * @param string $type the message type ('default' by default)
  26.     */
  27.     public static function add($message, $type = 'default') {
  28.         $_SESSION[self::$session_name][$type][] = $message;
  29.     }
  30.     
  31.     /**
  32.     * Clear messages for the given type
  33.     * @param string $type the message type ('default' by default)
  34.     */
  35.     public static function clear($type = 'default') {
  36.         $_SESSION[self::$session_name][$type] = array();
  37.     }
  38.     
  39.     /**
  40.     * Clear all messages
  41.     */
  42.     public static function clearAll() {
  43.         $_SESSION[self::$session_name] = array();
  44.     }
  45.     
  46.     /**
  47.     * Get messages for the given type
  48.     * @param string $type the message type ('default' by default)
  49.     * @return mixed array/null
  50.     */
  51.     public static function get($type = 'default') {
  52.         if (isset($_SESSION[self::$session_name][$type])) {
  53.             return $_SESSION[self::$session_name][$type];
  54.         }
  55.         
  56.         return null;
  57.     }
  58.     
  59.     /**
  60.     * Get all messages
  61.     * @return mixed array/null
  62.     */
  63.     public static function getAll() {
  64.         if (isset($_SESSION[self::$session_name])) {
  65.             return $_SESSION[self::$session_name];
  66.         }
  67.         
  68.         return null;
  69.     }
  70. }

Documentation generated on Mon, 19 Sep 2011 14:13:17 +0200 by phpDocumentor 1.4.3