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 settings.
 39:  *
 40:  * @package application.components.X2Settings
 41:  */
 42: abstract class X2Settings extends CBehavior {
 43: 
 44:     /**
 45:      * @var string|null $uid Allows state prefix to be explicitly set
 46:      */
 47:     public $uid = null; 
 48:     
 49:     /**
 50:      * @var string $modelClass class of model for which settings are being saved/retrieved
 51:      */
 52:     public $modelClass; 
 53: 
 54:     /**
 55:      * session/db JSON key
 56:      * @var string|null
 57:      */
 58:     private $_statePrefix; 
 59:     
 60:     // commented out since they might become useful
 61:     /**
 62:      * @param string $uid 
 63:      * @param array (<setting name> => <setting val>) $settings The settings to save
 64:      * @return bool true for success, false otherwise
 65:      */
 66:     //public function saveSettings ($uid, array $settings);
 67: 
 68:     /**
 69:      * @param string $uid 
 70:      */
 71:     //public function getSettings ($uid);
 72: 
 73:     /**
 74:      * @param string key the setting name
 75:      * @param string key the setting value
 76:      * @return bool true for success, false otherwise
 77:      */
 78:     abstract public function saveSetting ($key, $val);
 79: 
 80:     /**
 81:      * @param string key the setting name
 82:      * @return mixed The value of the gv setting
 83:      */
 84:     abstract public function getSetting ($key);
 85: 
 86:     /**
 87:      * state prefix defaults to uid or uid constructed from path and model id. It might be
 88:      * better to call this getUID since the state prefix isn't actually a prefix, it is the key in
 89:      * its entirety.
 90:      * @return string 
 91:      */
 92:     public function getStatePrefix () {
 93:         if (!isset ($this->_statePrefix)) {
 94:             if (isset ($this->uid)) {
 95:                 $this->_statePrefix = $this->uid;
 96:             } else {
 97:                 $this->_statePrefix = ((!Yii::app()->params->noSession ?
 98:                     Yii::app()->controller->uniqueid . '/' . Yii::app()->controller->action->id . 
 99:                         (isset($_GET['id']) ? '/' . $_GET['id'] : '') : '').
100:                     $this->modelClass);
101:             }
102:         }
103:         return $this->_statePrefix;
104:     }
105: 
106: }
107: ?>
108: