CRM/Utils/JSON.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Class handles functions for JSON format
  20  */
  21 class CRM_Utils_JSON {
  22
  23   /**
  24    * Output json to the client.
  25    * @param mixed $input
  26    */
  27   public static function output($input) {
  28     CRM_Utils_System::setHttpHeader('Content-Type', 'application/json');
  29     echo json_encode($input);
  30     CRM_Utils_System::civiExit();
  31   }
  32
  33   /**
  34    * Test whether the input string is valid JSON.
  35    * @param string $str
  36    * @return boolean
  37    */
  38   public static function isValidJSON($str) {
  39     json_decode($str);
  40     return json_last_error() == JSON_ERROR_NONE;
  41   }
  42
  43   /**
  44    * Do not use this function. See CRM-16353.
  45    * @deprecated
  46    *
  47    * @param array $params
  48    *   Associated array of row elements.
  49    * @param int $sEcho
  50    *   Datatable needs this to make it more secure.
  51    * @param int $iTotal
  52    *   Total records.
  53    * @param int $iFilteredTotal
  54    *   Total records on a page.
  55    * @param array $selectorElements
  56    *   Selector elements.
  57    * @return string
  58    */
  59   public static function encodeDataTableSelector($params, $sEcho, $iTotal, $iFilteredTotal, $selectorElements) {
  60     $sOutput = '{';
  61     $sOutput .= '"sEcho": ' . intval($sEcho) . ', ';
  62     $sOutput .= '"iTotalRecords": ' . $iTotal . ', ';
  63     $sOutput .= '"iTotalDisplayRecords": ' . $iFilteredTotal . ', ';
  64     $sOutput .= '"aaData": [ ';
  65     foreach ((array) $params as $key => $value) {
  66       $addcomma = FALSE;
  67       $sOutput .= "[";
  68       foreach ($selectorElements as $element) {
  69         if ($addcomma) {
  70           $sOutput .= ",";
  71         }
  72         // CRM-7130 --lets addslashes to only double quotes,
  73         // since we are using it to quote the field value.
  74         // str_replace helps to provide a break for new-line
  75         $sOutput .= '"' . addcslashes(str_replace(["\r\n", "\n", "\r"], '<br />', $value[$element]), '"\\') . '"';
  76
  77         // remove extra spaces and tab character that breaks dataTable CRM-12551
  78         $sOutput = preg_replace("/\s+/", " ", $sOutput);
  79         $addcomma = TRUE;
  80       }
  81       $sOutput .= "],";
  82     }
  83     $sOutput = substr_replace($sOutput, "", -1);
  84     $sOutput .= '] }';
  85
  86     return $sOutput;
  87   }
  88
  89 }