3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
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.
33 * $clean = civicrm_api('myentity', 'create', array(
41 * @copyright CiviCRM LLC (c) 2004-2013
45 require_once 'api/Wrapper.php';
46 class CRM_Utils_API_ReloadOption
implements API_Wrapper
{
49 * @var CRM_Utils_API_ReloadOption
51 private static $_singleton = NULL;
54 * @return CRM_Utils_API_ReloadOption
56 public static function singleton() {
57 if (self
::$_singleton === NULL) {
58 self
::$_singleton = new CRM_Utils_API_ReloadOption();
60 return self
::$_singleton;
66 public function fromApiInput($apiRequest) {
73 public function toApiOutput($apiRequest, $result) {
75 if ($apiRequest['action'] === 'create' && isset($apiRequest['params'], $apiRequest['params']['options'], $apiRequest['params']['options']['reload'])) {
76 if (!CRM_Utils_Array
::value('is_error', $result, FALSE)) {
77 $reloadMode = $apiRequest['params']['options']['reload'];
81 switch ($reloadMode) {
90 'id' => $result['id'],
92 $reloadResult = civicrm_api3($apiRequest['entity'], 'get', $params);
93 if ($reloadResult['is_error']) {
94 throw new API_Exception($reloadResult['error_message']);
96 $result['values'][$result['id']] = array_merge($result['values'][$result['id']], $reloadResult['values'][$result['id']]);
101 'id' => $result['id'],
102 'return' => $this->pickReturnFields($apiRequest),
104 $reloadResult = civicrm_api3($apiRequest['entity'], 'get', $params);
105 $result['values'][$result['id']] = array_merge($result['values'][$result['id']], $reloadResult['values'][$result['id']]);
109 throw new API_Exception("Unknown reload mode");
114 * Identify the fields which should be returned
119 public function pickReturnFields($apiRequest) {
120 $fields = civicrm_api3($apiRequest['entity'], 'getfields', array());
121 $returnKeys = array_intersect(
122 array_keys($apiRequest['params']),
123 array_keys($fields['values'])