CRM/Utils/JSON.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Class handles functions for JSON format
  38  */
  39 class CRM_Utils_JSON {
  40
  41   /**
  42    * Function to create JSON object
  43    *
  44    * @param  array  $params     associated array, that needs to be
  45    *                            converted to JSON array
  46    * @param  string $identifier identifier for the JSON array
  47    *
  48    * @return string $jsonObject JSON array
  49    * @static
  50    */
  51   static function encode($params, $identifier = 'id') {
  52     $buildObject = array();
  53     foreach ($params as $value) {
  54       $name = addslashes($value['name']);
  55       $buildObject[] = "{ name: \"$name\", {$identifier}:\"{$value[$identifier]}\"}";
  56     }
  57
  58     $jsonObject = '{ identifier: "' . $identifier . '", items: [' . implode(',', $buildObject) . ' ]}';
  59
  60     return $jsonObject;
  61   }
  62
  63   /**
  64    * Function to encode json format for flexigrid, NOTE: "id" should be present in $params for each row
  65    *
  66    * @param array  $params associated array of values rows
  67    * @param int    $page  page no for selector
  68    * @param array  $selectorElements selector rows
  69    *
  70    * @return json encode string
  71    */
  72   static function encodeSelector(&$params, $page, $total, $selectorElements) {
  73     $json = "";
  74     $json .= "{\n";
  75     $json .= "page: $page,\n";
  76     $json .= "total: $total,\n";
  77     $json .= "rows: [";
  78     $rc = FALSE;
  79
  80     foreach ($params as $key => $value) {
  81       if ($rc) {
  82         $json .= ",";
  83       }
  84       $json .= "\n{";
  85       $json .= "id:'" . $value['id'] . "',";
  86       $json .= "cell:[";
  87       $addcomma = FALSE;
  88       foreach ($selectorElements as $element) {
  89         if ($addcomma) {
  90           $json .= ",";
  91         }
  92         $json .= "'" . addslashes($value[$element]) . "'";
  93         $addcomma = TRUE;
  94       }
  95       $json .= "]}";
  96       $rc = TRUE;
  97     }
  98
  99     $json .= "]\n";
 100     $json .= "}";
 101
 102     return $json;
 103   }
 104
 105   /**
 106    * This function is used to encode data for dataTable plugin
 107    *
 108    * @param array $params associated array of row elements
 109    * @param int $sEcho datatable needs this to make it more secure
 110    * @param int $iTotal total records
 111    * @param int $iFilteredTotal total records on a page
 112    * @param array $selectorElements selector elements
 113    * @return string
 114    *
 115    */
 116   static function encodeDataTableSelector($params, $sEcho, $iTotal, $iFilteredTotal, $selectorElements) {
 117     $sOutput = '{';
 118     $sOutput .= '"sEcho": ' . intval($sEcho) . ', ';
 119     $sOutput .= '"iTotalRecords": ' . $iTotal . ', ';
 120     $sOutput .= '"iTotalDisplayRecords": ' . $iFilteredTotal . ', ';
 121     $sOutput .= '"aaData": [ ';
 122     foreach ($params as $key => $value) {
 123       $addcomma = FALSE;
 124       $sOutput .= "[";
 125       foreach ($selectorElements as $element) {
 126         if ($addcomma) {
 127           $sOutput .= ",";
 128         }
 129
 130         //CRM-7130 --lets addslashes to only double quotes,
 131         //since we are using it to quote the field value.
 132         //str_replace helps to provide a break for new-line
 133         $sOutput .= '"' . addcslashes(str_replace(array("\r\n", "\n", "\r"), '<br />', $value[$element]), '"\\') . '"';
 134
 135         //remove extra spaces and tab character that breaks dataTable CRM-12551
 136         $sOutput  = preg_replace("/\s+/", " ", $sOutput);
 137         $addcomma = TRUE;
 138       }
 139       $sOutput .= "],";
 140     }
 141     $sOutput = substr_replace($sOutput, "", -1);
 142     $sOutput .= '] }';
 143
 144     return $sOutput;
 145   }
 146 }
 147