CRM/Utils/API/ReloadOption.php

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