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 contact@x2engine.com.
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:  * Manages storage and retrieval of grid view settings.
39:  * Settings are stored in the $_SESSION PHP superglobal.
40:  * Grid view column settings and data provider results per page are not managed by this class.
41:  *
42:  * @package application.components.X2Settings
43:  */
44: class GridViewSessionSettingsBehavior extends X2Settings {
45:     
46:     /**
47:      * @param string $uid The UID of the grid view
48:      * @param string key the setting name
49:      * @param string val the setting value
50:      * @return bool true for success, false otherwise
51:      */
52:     public function saveSetting ($key, $val) {
53:         $uid = $this->getStatePrefix ();
54: 
55:         $gvSettings = CJSON::decode (Yii::app()->user->getState($uid));
56:         if (!is_array ($gvSettings))
57:             $gvSettings = array ();
58:         $gvSettings[$key] = $val;
59:         Yii::app()->user->setState($uid, CJSON::encode ($gvSettings));
60:         return true;
61:     }
62: 
63:     /**
64:      * @param string $uid The UID of the grid view
65:      * @param string key the setting name
66:      * @return null|mixed The value of the gv setting
67:      */
68:     public function getSetting ($key) {
69:         $uid = $this->getStatePrefix ();
70: 
71:         $gvSettings = CJSON::decode (Yii::app()->user->getState($uid));
72:         if (is_array ($gvSettings) && isset ($gvSettings[$key])) {
73:             return $gvSettings[$key];
74:         }
75:     }
76: 
77: }
78: ?>
79: