1: <?php
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address [email protected].
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * Used to collect error, notice, and success messages which can then be echoed back to the client.
 39:  * This can be used in conjunction with the UI library X2Flashes.js.
 40:  */
 41: 
 42: class X2Flashes {
 43: 
 44:     /**
 45:      * @var array used to hold success, warning, and error messages
 46:      */
 47:     private static $_flashes;
 48: 
 49:     public static function getFlashes() {
 50:         if (!isset (self::$_flashes)) {
 51:             self::$_flashes = array (
 52:                 'notice' => array (),
 53:                 'success' => array (),
 54:                 'error' => array (),
 55:             );
 56:         }
 57:         return self::$_flashes;
 58:     }
 59: 
 60:     public static function setFlashes ($flashes) {
 61:         self::$_flashes = $flashes;
 62:     }
 63: 
 64:     /**
 65:      * @return bool true if flashes have been added, false otherwise 
 66:      */
 67:     public static function hasFlashes ($type=null) {
 68:         $flashes = self::getFlashes ();
 69:         if ($type) {
 70:             $flashes = array ($type => $flashes[$type]);
 71:         }
 72:         return array_reduce (array_values ($flashes), function ($a, $b) { 
 73:             return $a + sizeof ($b); }) !== 0;
 74:     }
 75: 
 76:     /**
 77:      * Echoes flashes in the flash arrays
 78:      */
 79:     public static function echoFlashes () {
 80:         echo CJSON::encode (self::getFlashes ());
 81:     }
 82: 
 83:     public static function getFlashesResponse () {
 84:         return CJSON::encode (self::getFlashes ());
 85:     }
 86: 
 87:     /**
 88:      * Adds a flash of a specified type 
 89:      * @param string $key 'notice'|'success'|'error'
 90:      * @param string $message
 91:      */
 92:     public static function addFlash ($key, $message) {
 93:         $flashes = self::getFlashes ();
 94:         $flashes[$key][] = $message;
 95:         self::setFlashes ($flashes);
 96:     }
 97: 
 98: 
 99:     /**
100:      * Returns html for error, success, and notice flashes. 
101:      */
102:     public static function renderFlashes ($type) {
103:         $flashes = self::getFlashes ();
104: 
105:         if (isset ($flashes[$type])) {
106:             $flashes = $flashes[$type];
107:             foreach ($flashes as $flash) {
108:                 echo "<div class='flash-$type'>";
109:                 echo $flash;
110:                 echo "</div>";
111:             }
112:         }
113:     }
114: 
115:     public static function renderTopFlashes ($type) {
116:         $flashes = Yii::app()->user->getFlashes ();
117: 
118:         if (isset ($flashes[$type])) {
119:             $flash = $flashes[$type];
120:             $type = preg_replace ('/^top-/', '', $type);
121:             echo "
122:                 <div id='top-flashes-container-outer'>
123:                     <div id='top-flashes-container' class='flash-$type'>
124:                         <div id='top-flashes-message'>
125:                         $flash
126:                         </div>
127:                     </div>
128:                 
129:                 </div>";
130:         }
131:     }
132: 
133: }
134: 
135: ?>
136: