Commit | Line | Data |
---|---|---|
a9396478 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
34 | * $Id$ | |
35 | */ | |
36 | ||
37 | require_once 'api/Wrapper.php'; | |
38 | class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder { | |
39 | ||
40 | /** | |
41 | * @var CRM_Utils_API_NullOutputCoder | |
42 | */ | |
43 | private static $_singleton = NULL; | |
44 | ||
45 | /** | |
46 | * @return CRM_Utils_API_NullOutputCoder | |
47 | */ | |
48 | public static function singleton() { | |
49 | if (self::$_singleton === NULL) { | |
50 | self::$_singleton = new CRM_Utils_API_NullOutputCoder(); | |
51 | } | |
52 | return self::$_singleton; | |
53 | } | |
54 | ||
55 | /** | |
56 | * This function is going to filter the | |
57 | * submitted values across XSS vulnerability. | |
58 | * | |
59 | * @param array|string $values | |
60 | * @param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings) | |
61 | * If FALSE, then non-string values will be preserved | |
62 | */ | |
63 | public function encodeInput(&$values) { | |
64 | } | |
65 | ||
66 | public function decodeOutput(&$values, $castToString = FALSE) { | |
67 | if (is_array($values)) { | |
68 | foreach ($values as &$value) { | |
69 | $this->decodeOutput($value, TRUE); | |
70 | } | |
71 | } | |
72 | elseif ($castToString || is_string($values)) { | |
73 | if ($values === 'null') { | |
74 | $values = ''; | |
75 | } | |
76 | } | |
77 | } | |
78 | ||
79 | public function toApiOutput($apiRequest, $result) { | |
80 | $lowerAction = strtolower($apiRequest['action']); | |
81 | if ($lowerAction === 'create') { | |
82 | return parent::toApiOutput($apiRequest, $result); | |
83 | } else { | |
84 | return $result; | |
85 | } | |
86 | } | |
87 | } |