Commit | Line | Data |
---|---|---|
0e4d4398 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
0e4d4398 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
0e4d4398 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 | /** | |
dfd70ed4 TO |
29 | * Implement the "reload" option. This option can be used with "create" to force |
30 | * the API to reload a clean copy of the entity before returning the result. | |
0e4d4398 TO |
31 | * |
32 | * @code | |
33 | * $clean = civicrm_api('myentity', 'create', array( | |
34 | * 'options' => array( | |
35 | * 'reload' => 1 | |
36 | * ), | |
37 | * )); | |
38 | * @endcode | |
39 | * | |
40 | * @package CRM | |
06b69b18 | 41 | * @copyright CiviCRM LLC (c) 2004-2014 |
0e4d4398 TO |
42 | * $Id$ |
43 | */ | |
44 | ||
45 | require_once 'api/Wrapper.php'; | |
5bc392e6 EM |
46 | |
47 | /** | |
48 | * Class CRM_Utils_API_ReloadOption | |
49 | */ | |
0e4d4398 TO |
50 | class CRM_Utils_API_ReloadOption implements API_Wrapper { |
51 | ||
52 | /** | |
ac830223 | 53 | * @var CRM_Utils_API_ReloadOption |
0e4d4398 | 54 | */ |
ac830223 TO |
55 | private static $_singleton = NULL; |
56 | ||
57 | /** | |
58 | * @return CRM_Utils_API_ReloadOption | |
59 | */ | |
60 | public static function singleton() { | |
61 | if (self::$_singleton === NULL) { | |
62 | self::$_singleton = new CRM_Utils_API_ReloadOption(); | |
63 | } | |
64 | return self::$_singleton; | |
65 | } | |
0e4d4398 TO |
66 | |
67 | /** | |
e7c15cb6 | 68 | * @inheritDoc |
0e4d4398 TO |
69 | */ |
70 | public function fromApiInput($apiRequest) { | |
0e4d4398 TO |
71 | return $apiRequest; |
72 | } | |
73 | ||
74 | /** | |
e7c15cb6 | 75 | * @inheritDoc |
0e4d4398 TO |
76 | */ |
77 | public function toApiOutput($apiRequest, $result) { | |
5dc318b1 | 78 | $reloadMode = NULL; |
e5254c8a | 79 | if ($apiRequest['action'] === 'create' && isset($apiRequest['params'], $apiRequest['params']['options']) && is_array($apiRequest['params']['options']) && isset($apiRequest['params']['options']['reload'])) { |
5dc318b1 TO |
80 | if (!CRM_Utils_Array::value('is_error', $result, FALSE)) { |
81 | $reloadMode = $apiRequest['params']['options']['reload']; | |
82 | } | |
ac830223 TO |
83 | } |
84 | ||
85 | switch ($reloadMode) { | |
0e4d4398 TO |
86 | case NULL: |
87 | case '0': | |
88 | case 'null': | |
1788e919 | 89 | case '': |
0e4d4398 TO |
90 | return $result; |
91 | ||
92 | case '1': | |
93 | case 'default': | |
94 | $params = array( | |
95 | 'id' => $result['id'], | |
96 | ); | |
97 | $reloadResult = civicrm_api3($apiRequest['entity'], 'get', $params); | |
ac830223 TO |
98 | if ($reloadResult['is_error']) { |
99 | throw new API_Exception($reloadResult['error_message']); | |
100 | } | |
0e4d4398 TO |
101 | $result['values'][$result['id']] = array_merge($result['values'][$result['id']], $reloadResult['values'][$result['id']]); |
102 | return $result; | |
103 | ||
104 | case 'selected': | |
105 | $params = array( | |
106 | 'id' => $result['id'], | |
107 | 'return' => $this->pickReturnFields($apiRequest), | |
108 | ); | |
109 | $reloadResult = civicrm_api3($apiRequest['entity'], 'get', $params); | |
110 | $result['values'][$result['id']] = array_merge($result['values'][$result['id']], $reloadResult['values'][$result['id']]); | |
111 | return $result; | |
112 | ||
113 | default: | |
1788e919 | 114 | throw new API_Exception("Unknown reload mode " . $reloadMode); |
0e4d4398 TO |
115 | } |
116 | } | |
117 | ||
118 | /** | |
119 | * Identify the fields which should be returned | |
120 | * | |
121 | * @param $apiRequest | |
122 | * @return array | |
123 | */ | |
124 | public function pickReturnFields($apiRequest) { | |
125 | $fields = civicrm_api3($apiRequest['entity'], 'getfields', array()); | |
126 | $returnKeys = array_intersect( | |
127 | array_keys($apiRequest['params']), | |
128 | array_keys($fields['values']) | |
129 | ); | |
130 | return $returnKeys; | |
131 | } | |
132 | } |