inc/class.messages.php

   1 <?php
   2 //--------------------------------------------------------------------------------------------------
   3 // Session-Based Flash Messages v1.0
   4 // Copyright 2012 Mike Everhart (http://mikeeverhart.net)
   5 //
   6 //   Licensed under the Apache License, Version 2.0 (the "License");
   7 //   you may not use this file except in compliance with the License.
   8 //   You may obtain a copy of the License at
   9 //
  10 //     http://www.apache.org/licenses/LICENSE-2.0
  11 //
  12 //   Unless required by applicable law or agreed to in writing, software
  13 //   distributed under the License is distributed on an "AS IS" BASIS,
  14 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 //   See the License for the specific language governing permissions and
  16 //       limitations under the License.
  17 //
  18 //------------------------------------------------------------------------------
  19 // Description:
  20 //------------------------------------------------------------------------------
  21 //
  22 //      Stores messages in Session data to be easily retrieved later on.
  23 //      This class includes four different types of messages:
  24 //  - Success
  25 //  - Error
  26 //  - Warning
  27 //  - Information
  28 //
  29 //  See README for basic usage instructions, or see samples/index.php for more advanced samples
  30 //
  31 //--------------------------------------------------------------------------------------------------
  32 // Changelog
  33 //--------------------------------------------------------------------------------------------------
  34 //
  35 //      2011-05-15 - v1.0 - Initial Version
  36 //
  37 //--------------------------------------------------------------------------------------------------
  38
  39 class Messages {
  40
  41         //-----------------------------------------------------------------------------------------------
  42         // Class Variables
  43         //-----------------------------------------------------------------------------------------------
  44         var $msgId;
  45         var $msgTypes = array( 'help', 'info', 'warning', 'success', 'error' );
  46         var $msgClass = 'messages';
  47         var $msgWrapper = "<div class='%s %s'><a href='#' class='closeMessage'></a>\n%s</div>\n";
  48         var $msgBefore = '<p>';
  49         var $msgAfter = "</p>\n";
  50
  51
  52         /**
  53          * Constructor
  54          * @author Mike Everhart
  55          */
  56         public function __construct() {
  57
  58                 // Generate a unique ID for this user and session
  59                 $this->msgId = md5(uniqid());
  60
  61                 // Create the session array if it doesnt already exist
  62                 if( !array_key_exists('flash_messages', $_SESSION) ) $_SESSION['flash_messages'] = array();
  63
  64         }
  65
  66         /**
  67          * Add a message to the queue
  68          *
  69          * @author Mike Everhart
  70          *
  71          * @param  string   $type               The type of message to add
  72          * @param  string   $message            The message
  73          * @param  string   $redirect_to        (optional) If set, the user will be redirected to this URL
  74          * @return  bool
  75          *
  76          */
  77         public function add($type, $message, $redirect_to=null) {
  78
  79                 if( !isset($_SESSION['flash_messages']) ) return false;
  80
  81                 if( !isset($type) || !isset($message[0]) ) return false;
  82
  83                 // Replace any shorthand codes with their full version
  84                 if( strlen(trim($type)) == 1 ) {
  85                         $type = str_replace( array('h', 'i', 'w', 'e', 's'), array('help', 'info', 'warning', 'error', 'success'), $type );
  86
  87                 // Backwards compatibility...
  88                 } elseif( $type == 'information' ) {
  89                         $type = 'info';
  90                 }
  91
  92                 // Make sure it's a valid message type
  93                 if( !in_array($type, $this->msgTypes) ) die('"' . strip_tags($type) . '" is not a valid message type!' );
  94
  95                 // If the session array doesn't exist, create it
  96                 if( !array_key_exists( $type, $_SESSION['flash_messages'] ) ) $_SESSION['flash_messages'][$type] = array();
  97
  98                 $_SESSION['flash_messages'][$type][] = $message;
  99
 100                 if( !is_null($redirect_to) ) {
 101                         header("Location: $redirect_to");
 102                         exit();
 103                 }
 104
 105                 return true;
 106
 107         }
 108
 109         //-----------------------------------------------------------------------------------------------
 110         // display()
 111         // print queued messages to the screen
 112         //-----------------------------------------------------------------------------------------------
 113         /**
 114          * Display the queued messages
 115          *
 116          * @author Mike Everhart
 117          *
 118          * @param  string   $type     Which messages to display
 119          * @param  bool         $print    True  = print the messages on the screen
 120          * @return mixed
 121          *
 122          */
 123         public function display($type='all', $print=true) {
 124                 $messages = '';
 125                 $data = '';
 126
 127                 if( !isset($_SESSION['flash_messages']) ) return false;
 128
 129                 if( $type == 'g' || $type == 'growl' ) {
 130                         $this->displayGrowlMessages();
 131                         return true;
 132                 }
 133
 134                 // Print a certain type of message?
 135                 if( in_array($type, $this->msgTypes) ) {
 136                         foreach( $_SESSION['flash_messages'][$type] as $msg ) {
 137                                 $messages .= $this->msgBefore . $msg . $this->msgAfter;
 138                         }
 139
 140                         $data .= sprintf($this->msgWrapper, $this->msgClass, $type, $messages);
 141
 142                         // Clear the viewed messages
 143                         $this->clear($type);
 144
 145                 // Print ALL queued messages
 146                 } elseif( $type == 'all' ) {
 147                         foreach( $_SESSION['flash_messages'] as $type => $msgArray ) {
 148                                 $messages = '';
 149                                 foreach( $msgArray as $msg ) {
 150                                         $messages .= $this->msgBefore . $msg . $this->msgAfter;
 151                                 }
 152                                 $data .= sprintf($this->msgWrapper, $this->msgClass, $type, $messages);
 153                         }
 154
 155                         // Clear ALL of the messages
 156                         $this->clear();
 157
 158                 // Invalid Message Type?
 159                 } else {
 160                         return false;
 161                 }
 162
 163                 // Print everything to the screen or return the data
 164                 if( $print ) {
 165                         echo $data;
 166                 } else {
 167                         return $data;
 168                 }
 169         }
 170
 171
 172         /**
 173          * Check to  see if there are any queued error messages
 174          *
 175          * @author Mike Everhart
 176          *
 177          * @return bool  true  = There ARE error messages
 178          *               false = There are NOT any error messages
 179          *
 180          */
 181         public function hasErrors() {
 182                 return empty($_SESSION['flash_messages']['error']) ? false : true;
 183         }
 184
 185         /**
 186          * Check to see if there are any ($type) messages queued
 187          *
 188          * @author Mike Everhart
 189          *
 190          * @param  string   $type     The type of messages to check for
 191          * @return bool
 192          *
 193          */
 194         public function hasMessages($type=null) {
 195                 if( !is_null($type) ) {
 196                         if( !empty($_SESSION['flash_messages'][$type]) ) return $_SESSION['flash_messages'][$type];
 197                 } else {
 198                         foreach( $this->msgTypes as $type ) {
 199                                 if( !empty($_SESSION['flash_messages']) ) return true;
 200                         }
 201                 }
 202                 return false;
 203         }
 204
 205         /**
 206          * Clear messages from the session data
 207          *
 208          * @author Mike Everhart
 209          *
 210          * @param  string   $type     The type of messages to clear
 211          * @return bool
 212          *
 213          */
 214         public function clear($type='all') {
 215                 if( $type == 'all' ) {
 216                         unset($_SESSION['flash_messages']);
 217                 } else {
 218                         unset($_SESSION['flash_messages'][$type]);
 219                 }
 220                 return true;
 221         }
 222
 223         public function __toString() { return $this->hasMessages();     }
 224
 225         public function __destruct() {
 226                 //$this->clear();
 227         }
 228
 229
 230 } // end class
 231 ?>