drupal-civicrm/sites/all/modules/civicrm/CRM/Utils/API/NullOutputCoder.php

104 lines
3.2 KiB
PHP
Raw Normal View History

2018-01-14 15:10:16 +02:00
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* Work-around for CRM-13120 - The "create" action incorrectly returns string literal "null"
* when the actual value is NULL or "". Rewrite the output.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
*/
require_once 'api/Wrapper.php';
/**
* Class CRM_Utils_API_NullOutputCoder
*/
class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder {
/**
* @var CRM_Utils_API_NullOutputCoder
*/
private static $_singleton = NULL;
/**
* @return CRM_Utils_API_NullOutputCoder
*/
public static function singleton() {
if (self::$_singleton === NULL) {
self::$_singleton = new CRM_Utils_API_NullOutputCoder();
}
return self::$_singleton;
}
/**
* Going to filter the submitted values across XSS vulnerability.
*
* @param array|string $values
*/
public function encodeInput(&$values) {
}
/**
* Decode output.
*
* @param array $values
* @param bool $castToString
*/
public function decodeOutput(&$values, $castToString = FALSE) {
if (is_array($values)) {
foreach ($values as &$value) {
$this->decodeOutput($value, TRUE);
}
}
elseif ($castToString || is_string($values)) {
if ($values === 'null') {
$values = '';
}
}
}
/**
* To api output.
*
* @param array $apiRequest
* @param array $result
*
* @return array
*/
public function toApiOutput($apiRequest, $result) {
$lowerAction = strtolower($apiRequest['action']);
if ($lowerAction === 'create') {
return parent::toApiOutput($apiRequest, $result);
}
else {
return $result;
}
}
}