CRM/Utils/API/NullOutputCoder.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * Work-around for CRM-13120 - The "create" action incorrectly returns string literal "null"
  30  * when the actual value is NULL or "". Rewrite the output.
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2015
  34  */
  35
  36 require_once 'api/Wrapper.php';
  37
  38 /**
  39  * Class CRM_Utils_API_NullOutputCoder
  40  */
  41 class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder {
  42
  43   /**
  44    * @var CRM_Utils_API_NullOutputCoder
  45    */
  46   private static $_singleton = NULL;
  47
  48   /**
  49    * @return CRM_Utils_API_NullOutputCoder
  50    */
  51   public static function singleton() {
  52     if (self::$_singleton === NULL) {
  53       self::$_singleton = new CRM_Utils_API_NullOutputCoder();
  54     }
  55     return self::$_singleton;
  56   }
  57
  58   /**
  59    * going to filter the
  60    * submitted values across XSS vulnerability.
  61    *
  62    * @param array|string $values
  63    *
  64    * @internal param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings)
  65    *    If FALSE, then non-string values will be preserved
  66    */
  67   public function encodeInput(&$values) {
  68   }
  69
  70   /**
  71    * @param $values
  72    * @param bool $castToString
  73    */
  74   public function decodeOutput(&$values, $castToString = FALSE) {
  75     if (is_array($values)) {
  76       foreach ($values as &$value) {
  77         $this->decodeOutput($value, TRUE);
  78       }
  79     }
  80     elseif ($castToString || is_string($values)) {
  81       if ($values === 'null') {
  82         $values = '';
  83       }
  84     }
  85   }
  86
  87   /**
  88    * @inheritDoc
  89    */
  90   /**
  91    * @param $apiRequest
  92    * @param $result
  93    *
  94    * @return modified
  95    */
  96   public function toApiOutput($apiRequest, $result) {
  97     $lowerAction = strtolower($apiRequest['action']);
  98     if ($lowerAction === 'create') {
  99       return parent::toApiOutput($apiRequest, $result);
 100     }
 101     else {
 102       return $result;
 103     }
 104   }
 105
 106 }