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: Yii::import('application.components.util.ArrayUtil');
 38: Yii::import('application.components.JSONFieldsBehavior');
 39: 
 40: /**
 41:  * Enables transparent serialization and storage of array objects in database
 42:  * fields as JSON strings.
 43:  * @package application.components
 44:  * @author Demitri Morgan <demitri@x2engine.com>, Derek Mueller <derek@x2engine.com>
 45:  */
 46: class NormalizedJSONFieldsBehavior extends JSONFieldsBehavior {
 47: 
 48:     protected $_fields;
 49: 
 50:     protected $hasOptions = true;
 51: 
 52:     /**
 53:      * If true, when setting the JSON field, the order of the current field values will be 
 54:      *  maintained.
 55:      * @param bool 
 56:      */
 57:     public $maintainCurrentFieldsOrder = false; 
 58: 
 59:     /**
 60:      * Returns an array defining the expected structure of the JSON-bearing
 61:      * attribute specified by $name.
 62:      *
 63:      * Child classes can override this method to specify default values for
 64:      * fields in the embedded JSON object other than null (in this class, all
 65:      * embedded fields within all attributes are null by default).
 66:      *
 67:      * @param
 68:      * @return type
 69:      */
 70:     public function fields($name) {
 71:         if(!isset($this->_fields)) {
 72:             $this->_fields = array();
 73:             // Assume all are null by default:
 74:             foreach($this->transformAttributes as $attr => $fields)
 75:                 $this->_fields[$attr] = array_fill_keys($fields,null);
 76:         }
 77:         return $this->_fields[$name];
 78:     }
 79: 
 80:     /**
 81:      * Normalizes the attribute array to the structure defined in {@link fields}
 82:      * and then JSON-encodes it to prepare it for saving.
 83:      * @param type $name
 84:      * @return type
 85:      */
 86:     public function packAttribute($name){
 87:         $fields = $this->fields($name);
 88:         $attribute = $this->getOwner()->$name;
 89:         $attribute = is_array($attribute) ? 
 90:             ArrayUtil::normalizeToArrayR($fields,$attribute,$this->maintainCurrentFieldsOrder) : $fields;
 91:         return CJSON::encode ($attribute);
 92:     }
 93: 
 94:     /**
 95:      * JSON-decodes the value stored in the database column for the attribute,
 96:      * and then normalizes it to the structure defined in {@link fields}
 97:      * @param string $name The attribute to be unpacked
 98:      * @return type
 99:      */
100:     public function unpackAttribute($name){
101:         $fields = $this->fields($name);
102:         $attribute = CJSON::decode ($this->getOwner()->$name);
103:         $attribute = is_array($attribute) ? 
104:             ArrayUtil::normalizeToArrayR($fields,$attribute,$this->maintainCurrentFieldsOrder) : $fields;
105:         return $attribute;
106:     }
107: }
108: 
109: ?>
110: