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:  * Manages storage and retrieval of grid view settings.
 39:  * Settings are stored in the generalGridViewSettings attribute of the user's profile record.
 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 GridViewDbSettingsBehavior extends X2Settings {
 45:     
 46: // commented out since they might become useful
 47:     /**
 48:      * @param string $uid The UID of the grid view
 49:      * @param array (<setting name> => <setting val>) $settings The settings to save
 50:      * @return bool true for success, false otherwise
 51:      */
 52: //    public function saveSettings ($uid, array $settings) {
 53: //        $profile = Yii::app()->params->profile;
 54: //        $gvSettings = CJSON::decode ($profile->generalGridViewSettings); 
 55: //        if (!is_array ($gvSettings))
 56: //            $gvSettings = array ();
 57: //        $gvSettings[$uid] = $settings;
 58: //        $profile->generalGridViewSettings = CJSON::encode ($gvSettings);
 59: //        return $profile->save ();
 60: //    }
 61: //
 62: //    /**
 63: //     * @param string $uid The UID of the grid view
 64: //     */
 65: //    public function getSettings ($uid) {
 66: //        $profile = Yii::app()->params->profile;
 67: //        $gvSettings = CJSON::decode ($profile->generalGridViewSettings); 
 68: //        return CJSON::decode ($gvSettings[$uid]);
 69: //    }
 70: 
 71:     /**
 72:      * @param string $uid The UID of the grid view
 73:      * @param string key the setting name
 74:      * @param string key the setting value
 75:      * @return bool true for success, false otherwise
 76:      */
 77:     public function saveSetting ($key, $val) {
 78:         $uid = $this->getStatePrefix ();
 79:         $profile = Yii::app()->params->profile;
 80:         $gvSettings = CJSON::decode ($profile->generalGridViewSettings); 
 81:         if (!is_array ($gvSettings))
 82:             $gvSettings = array ();
 83:         if (!isset ($gvSettings[$uid]) || !is_array ($gvSettings[$uid]))
 84:             $gvSettings[$uid] = array ();
 85:         $gvSettings[$uid][$key] = $val;
 86:         $profile->generalGridViewSettings = CJSON::encode ($gvSettings);
 87:         return $profile->save ();
 88:     }
 89: 
 90:     /**
 91:      * @param string $uid The UID of the grid view
 92:      * @param string key the setting name
 93:      * @return mixed The value of the gv setting
 94:      */
 95:     public function getSetting ($key) {
 96:         $uid = $this->getStatePrefix ();
 97:         $profile = Yii::app()->params->profile;
 98:         $gvSettings = CJSON::decode ($profile->generalGridViewSettings); 
 99:         if (is_array ($gvSettings) && isset ($gvSettings[$uid]) && is_array ($gvSettings[$uid]) &&
100:             isset ($gvSettings[$uid][$key])) {
101: 
102:             return $gvSettings[$uid][$key];
103:         }
104:     }
105: 
106: }
107: ?>
108: