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