3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 "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).
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
41 * $result = civicrm_api('contact', 'create', array(
43 * 'match' => array('last_name', 'first_name')
45 * 'first_name' => 'Jeffrey',
46 * 'last_name' => 'Lebowski',
47 * 'nick_name' => 'The Dude',
52 * @copyright CiviCRM LLC (c) 2004-2019
55 require_once 'api/Wrapper.php';
58 * Class CRM_Utils_API_MatchOption
60 class CRM_Utils_API_MatchOption
implements API_Wrapper
{
63 * @var CRM_Utils_API_MatchOption
65 private static $_singleton = NULL;
70 * @return CRM_Utils_API_MatchOption
72 public static function singleton() {
73 if (self
::$_singleton === NULL) {
74 self
::$_singleton = new CRM_Utils_API_MatchOption();
76 return self
::$_singleton;
82 public function fromApiInput($apiRequest) {
84 // Parse options.match or options.match-mandatory
86 if (isset($apiRequest['params'], $apiRequest['params']['options']) && is_array($apiRequest['params']['options'])) {
87 if (isset($apiRequest['params']['options']['match-mandatory'])) {
89 $keys = $apiRequest['params']['options']['match-mandatory'];
91 elseif (isset($apiRequest['params']['options']['match'])) {
93 $keys = $apiRequest['params']['options']['match'];
95 if (is_string($keys)) {
100 // If one of the options was specified, then try to match records.
101 // Matching logic differs for 'create' and 'replace' actions.
102 if ($keys !== NULL) {
103 switch ($apiRequest['action']) {
105 if (empty($apiRequest['params']['id'])) {
106 $apiRequest['params'] = $this->match($apiRequest['entity'], $apiRequest['params'], $keys, $isMandatory);
111 // In addition to matching on the listed keys, also match on the set-definition keys.
112 // For example, if the $apiRequest is to "replace the set of civicrm_emails for contact_id=123 while
113 // matching emails on location_type_id", then we would need to search for pre-existing emails using
114 // both 'contact_id' and 'location_type_id'
115 $baseParams = _civicrm_api3_generic_replace_base_params($apiRequest['params']);
116 $keys = array_unique(array_merge(
117 array_keys($baseParams),
121 // attempt to match each replacement item
122 foreach ($apiRequest['params']['values'] as $offset => $createParams) {
123 $createParams = array_merge($baseParams, $createParams);
124 $createParams = $this->match($apiRequest['entity'], $createParams, $keys, $isMandatory);
125 $apiRequest['params']['values'][$offset] = $createParams;
130 // be forgiving of sloppy api calls
138 * Attempt to match a contact. This filters/updates the $createParams if there is a match.
140 * @param string $entity
141 * @param array $createParams
143 * @param bool $isMandatory
146 * revised $createParams, including 'id' if known
147 * @throws API_Exception
149 public function match($entity, $createParams, $keys, $isMandatory) {
150 $getParams = $this->createGetParams($createParams, $keys);
151 $getResult = civicrm_api3($entity, 'get', $getParams);
152 if ($getResult['count'] == 0) {
154 throw new API_Exception("Failed to match existing record");
156 return $createParams; // OK, don't care
158 elseif ($getResult['count'] == 1) {
159 $item = array_shift($getResult['values']);
160 $createParams['id'] = $item['id'];
161 return $createParams;
164 throw new API_Exception("Ambiguous match criteria");
171 public function toApiOutput($apiRequest, $result) {
176 * Create APIv3 "get" parameters to lookup an existing record using $keys
178 * @param array $origParams
181 * List of keys to match against.
186 public function createGetParams($origParams, $keys) {
187 $params = ['version' => 3];
188 foreach ($keys as $key) {
189 $params[$key] = CRM_Utils_Array
::value($key, $origParams, '');