CRM/Utils/API/MatchOption.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 "match" and "match-mandatory" options. If the submitted record doesn't have an ID
  30  * but a "match" key is specified, then we will automatically search for pre-existing record and
  31  * fill-in the missing ID. The "match" or "match-mandatory" can specified as a string (the name of the key
  32  * to match on) or array (the names of several keys to match on).
  33  *
  34  * Note that "match" and "match-mandatory" behave the same in the case where one matching record
  35  * exists (ie they update the record). They also behave the same if there are multiple matching
  36  * records (ie they throw an error).  However, if there is no matching record, they differ:
  37  *   - "match-mandatory" will generate an error
  38  *   - "match" will allow action to proceed -- thus inserting a new record
  39  *
  40  * @code
  41  * $result = civicrm_api('contact', 'create', array(
  42  *   'options' => array(
  43  *     'match' => array('last_name', 'first_name')
  44  *   ),
  45  *   'first_name' => 'Jeffrey',
  46  *   'last_name' => 'Lebowski',
  47  *   'nick_name' => 'The Dude',
  48  * ));
  49  * @endcode
  50  *
  51  * @package CRM
  52  * @copyright CiviCRM LLC (c) 2004-2015
  53  * $Id$
  54  */
  55
  56 require_once 'api/Wrapper.php';
  57
  58 /**
  59  * Class CRM_Utils_API_MatchOption
  60  */
  61 class CRM_Utils_API_MatchOption implements API_Wrapper {
  62
  63   /**
  64    * @var CRM_Utils_API_MatchOption
  65    */
  66   private static $_singleton = NULL;
  67
  68   /**
  69    * @return CRM_Utils_API_MatchOption
  70    */
  71   public static function singleton() {
  72     if (self::$_singleton === NULL) {
  73       self::$_singleton = new CRM_Utils_API_MatchOption();
  74     }
  75     return self::$_singleton;
  76   }
  77
  78   /**
  79    * @inheritDoc
  80    */
  81   public function fromApiInput($apiRequest) {
  82
  83     // Parse options.match or options.match-mandatory
  84     $keys = NULL; // array of fields to match against
  85     if (isset($apiRequest['params'], $apiRequest['params']['options']) && is_array($apiRequest['params']['options'])) {
  86       if (isset($apiRequest['params']['options']['match-mandatory'])) {
  87         $isMandatory = TRUE;
  88         $keys = $apiRequest['params']['options']['match-mandatory'];
  89       }
  90       elseif (isset($apiRequest['params']['options']['match'])) {
  91         $isMandatory = FALSE;
  92         $keys = $apiRequest['params']['options']['match'];
  93       }
  94       if (is_string($keys)) {
  95         $keys = array($keys);
  96       }
  97     }
  98
  99     // If one of the options was specified, then try to match records.
 100     // Matching logic differs for 'create' and 'replace' actions.
 101     if ($keys !== NULL) {
 102       switch ($apiRequest['action']) {
 103         case 'create':
 104           if (empty($apiRequest['params']['id'])) {
 105             $apiRequest['params'] = $this->match($apiRequest['entity'], $apiRequest['params'], $keys, $isMandatory);
 106           }
 107           break;
 108
 109         case 'replace':
 110           // In addition to matching on the listed keys, also match on the set-definition keys.
 111           // For example, if the $apiRequest is to "replace the set of civicrm_emails for contact_id=123 while
 112           // matching emails on location_type_id", then we would need to search for pre-existing emails using
 113           // both 'contact_id' and 'location_type_id'
 114           $baseParams = _civicrm_api3_generic_replace_base_params($apiRequest['params']);
 115           $keys = array_unique(array_merge(
 116             array_keys($baseParams),
 117             $keys
 118           ));
 119
 120           // attempt to match each replacement item
 121           foreach ($apiRequest['params']['values'] as $offset => $createParams) {
 122             $createParams = array_merge($baseParams, $createParams);
 123             $createParams = $this->match($apiRequest['entity'], $createParams, $keys, $isMandatory);
 124             $apiRequest['params']['values'][$offset] = $createParams;
 125           }
 126           break;
 127
 128         default:
 129           // be forgiveful of sloppily api calls
 130       }
 131     }
 132
 133     return $apiRequest;
 134   }
 135
 136   /**
 137    * Attempt to match a contact. This filters/updates the $createParams if there is a match.
 138    *
 139    * @param string $entity
 140    * @param array $createParams
 141    * @param array $keys
 142    * @param bool $isMandatory
 143    * @return array
 144    *   revised $createParams, including 'id' if known
 145    * @throws API_Exception
 146    */
 147   public function match($entity, $createParams, $keys, $isMandatory) {
 148     $getParams = $this->createGetParams($createParams, $keys);
 149     $getResult = civicrm_api3($entity, 'get', $getParams);
 150     if ($getResult['count'] == 0) {
 151       if ($isMandatory) {
 152         throw new API_Exception("Failed to match existing record");
 153       }
 154       return $createParams; // OK, don't care
 155     }
 156     elseif ($getResult['count'] == 1) {
 157       $item = array_shift($getResult['values']);
 158       $createParams['id'] = $item['id'];
 159       return $createParams;
 160     }
 161     else {
 162       throw new API_Exception("Ambiguous match criteria");
 163     }
 164   }
 165
 166   /**
 167    * @inheritDoc
 168    */
 169   public function toApiOutput($apiRequest, $result) {
 170     return $result;
 171   }
 172
 173   /**
 174    * Create APIv3 "get" parameters to lookup an existing record using $keys
 175    *
 176    * @param array $origParams
 177    *   Api request.
 178    * @param array $keys
 179    *   List of keys to match against.
 180    *
 181    * @return array
 182    *   APIv3 $params
 183    */
 184   public function createGetParams($origParams, $keys) {
 185     $params = array('version' => 3);
 186     foreach ($keys as $key) {
 187       $params[$key] = CRM_Utils_Array::value($key, $origParams, '');
 188     }
 189     return $params;
 190   }
 191
 192 }