include/JSON.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3
   4 /*********************************************************************************
   5  * SugarCRM Community Edition is a customer relationship management program developed by
   6  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Affero General Public License version 3 as published by the
  10  * Free Software Foundation with the addition of the following permission added
  11  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License along with
  21  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301 USA.
  24  *
  25  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27  *
  28  * The interactive user interfaces in modified source and object code versions
  29  * of this program must display Appropriate Legal Notices, as required under
  30  * Section 5 of the GNU Affero General Public License version 3.
  31  *
  32  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33  * these Appropriate Legal Notices must retain the display of the "Powered by
  34  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  35  * technical reasons, the Appropriate Legal Notices must display the words
  36  * "Powered by SugarCRM".
  37  ********************************************************************************/
  38
  39 /*********************************************************************************
  40
  41  * Description:  Includes generic helper functions used throughout the application.
  42  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  43  * All Rights Reserved.
  44  * Contributor(s): ______________________________________..
  45  ********************************************************************************/
  46
  47 /**
  48  * This class used to perform json encode / decode functions but has now been replaced by
  49  * the built in php.
  50  *
  51  * Note: We no longer eval our json so there is no more need for security envelopes. The parameter
  52  * has been left for backwards compatibility.
  53  * @api
  54  */
  55 class JSON
  56 {
  57
  58     /**
  59      * JSON encode a string
  60      *
  61      * @param string $string
  62      * @param bool $addSecurityEnvelope defaults to false
  63      * @param bool $encodeSpecial
  64      * @return string
  65      */
  66     public static function encode($string, $addSecurityEnvelope = false, $encodeSpecial = false)
  67     {
  68         $encodedString = json_encode($string);
  69
  70         if ($encodeSpecial)
  71         {
  72             $charMap = array('<' => '\u003C', '>' => '\u003E', "'" => '\u0027', '&' => '\u0026');
  73             foreach($charMap as $c => $enc)
  74             {
  75                 $encodedString = str_replace($c, $enc, $encodedString);
  76             }
  77         }
  78
  79         return $encodedString;
  80     }
  81
  82     /**
  83      * JSON decode a string
  84      *
  85      * @param string $string
  86      * @param bool $examineEnvelope Default false, true to extract and verify envelope
  87      * @param bool $assoc
  88      * @return string
  89      */
  90     public static function decode($string, $examineEnvelope=false, $assoc = true)
  91     {
  92         return json_decode($string,$assoc);
  93     }
  94
  95     /**
  96      * @deprecated use JSON::encode() instead
  97      */
  98     public static function encodeReal($string)
  99     {
 100         return self::encode($string);
 101     }
 102
 103     /**
 104      * @deprecated use JSON::decode() instead
 105      */
 106     public static function decodeReal($string)
 107     {
 108         return self::decode($string);
 109     }
 110 }