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 * File for CiviCRM APIv3 utilitity functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_utils
34 * @copyright CiviCRM LLC (c) 2004-2013
35 * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $
40 * Initialize CiviCRM - should be run at the start of each API function
42 function _civicrm_api3_initialize() {
43 require_once 'CRM/Core/ClassLoader.php';
44 CRM_Core_ClassLoader
::singleton()->register();
45 CRM_Core_Config
::singleton();
49 * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
51 * @param array $params array of fields to checkl
52 * @param array $daoName string DAO to check for required fields (create functions only)
53 * @param array $keyoptions
55 * @internal param array $keys list of required fields options. One of the options is required
56 * @return null or throws error if there the required fields not present
59 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
61 $keys = array(array());
62 foreach ($keyoptions as $key) {
65 civicrm_api3_verify_mandatory($params, $daoName, $keys);
69 * Function to check mandatory fields are included
71 * @param array $params array of fields to check
72 * @param array $daoName string DAO to check for required fields (create functions only)
73 * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
74 * @param bool $verifyDAO
76 * @throws API_Exception
77 * @return null or throws error if there the required fields not present
79 * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
81 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
82 ), $verifyDAO = TRUE) {
85 if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
86 $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
87 if (!is_array($unmatched)) {
92 if (!empty($params['id'])) {
93 $keys = array('version');
96 if (!in_array('version', $keys)) {
97 // required from v3 onwards
101 foreach ($keys as $key) {
102 if (is_array($key)) {
104 $optionset = array();
105 foreach ($key as $subkey) {
106 if (!array_key_exists($subkey, $params) ||
empty($params[$subkey])) {
107 $optionset[] = $subkey;
110 // as long as there is one match then we don't need to rtn anything
114 if (empty($match) && !empty($optionset)) {
115 $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
119 // Disallow empty values except for the number zero.
120 // TODO: create a utility for this since it's needed in many places
121 if (!array_key_exists($key, $params) ||
(empty($params[$key]) && $params[$key] !== 0 && $params[$key] !== '0')) {
126 if (!empty($unmatched)) {
127 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
133 * @param <type> $data
135 * @param object $dao DAO / BAO object to be freed here
137 * @throws API_Exception
138 * @return array <type>
140 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
141 //fix me - $dao should be param 4 & 3 should be $apiRequest
142 if (is_object($dao)) {
146 if (is_array($dao)) {
147 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
149 $fields = _civicrm_api3_api_getfields($dao);
150 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE);
152 catch(Exception
$e) {
153 $msg = $e->getMessage();
157 $data['is_error'] = 1;
158 $data['error_message'] = $msg;
159 // we will show sql to privelledged user only (not sure of a specific
160 // security hole here but seems sensible - perhaps should apply to the trace as well?
161 if(isset($data['sql']) && CRM_Core_Permission
::check('Administer CiviCRM')) {
162 $data['debug_information'] = $data['sql'];
164 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array
::value('api.has_parent', $dao['params'])) {
165 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
166 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
172 * Format array in result output styple
174 * @param array $values values generated by API operation (the result)
175 * @param array $params parameters passed into API call
176 * @param string $entity the entity being acted on
177 * @param string $action the action passed to the API
178 * @param object $dao DAO object to be freed here
179 * @param array $extraReturnValues additional values to be added to top level of result array(
180 * - this param is currently used for legacy behaviour support
182 * @return array $result
184 function civicrm_api3_create_success($values = 1, $params = array(
185 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
187 $result['is_error'] = 0;
188 //lets set the ['id'] field if it's not set & we know what the entity is
189 if (is_array($values) && !empty($entity)) {
190 foreach ($values as $key => $item) {
191 if (empty($item['id']) && !empty($item[$entity . "_id"])) {
192 $values[$key]['id'] = $item[$entity . "_id"];
194 if(!empty($item['financial_type_id'])){
195 //4.3 legacy handling
196 $values[$key]['contribution_type_id'] = $item['financial_type_id'];
198 if(!empty($item['next_sched_contribution_date'])){
199 // 4.4 legacy handling
200 $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
205 if (is_array($params) && !empty($params['debug'])) {
206 if (is_string($action) && $action != 'getfields') {
207 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) +
$params);
209 elseif ($action != 'getfields') {
210 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
216 $allFields = array();
217 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
218 $allFields = array_keys($apiFields['values']);
220 $paramFields = array_keys($params);
221 $undefined = array_diff($paramFields, $allFields, array_keys($_COOKIE), array('action', 'entity', 'debug', 'version', 'check_permissions', 'IDS_request_uri', 'IDS_user_agent', 'return', 'sequential', 'rowCount', 'option_offset', 'option_limit', 'custom', 'option_sort', 'options'));
223 $result['undefined_fields'] = array_merge($undefined);
226 if (is_object($dao)) {
230 $result['version'] = 3;
231 if (is_array($values)) {
232 $result['count'] = (int) count($values);
234 // Convert value-separated strings to array
235 _civicrm_api3_separate_values($values);
237 if ($result['count'] == 1) {
238 list($result['id']) = array_keys($values);
240 elseif (!empty($values['id']) && is_int($values['id'])) {
241 $result['id'] = $values['id'];
245 $result['count'] = !empty($values) ?
1 : 0;
248 if (is_array($values) && isset($params['sequential']) &&
249 $params['sequential'] == 1
251 $result['values'] = array_values($values);
254 $result['values'] = $values;
256 if(!empty($params['options']['metadata'])) {
257 // we've made metadata an array but only supporting 'fields' atm
258 if(in_array('fields', $params['options']['metadata'])) {
259 $fields = civicrm_api3($entity, 'getfields', array('action' => $action));
260 $result['metadata']['fields'] = $fields['values'];
263 return array_merge($result, $extraReturnValues);
267 * Load the DAO of the entity
269 function _civicrm_api3_load_DAO($entity) {
270 $dao = _civicrm_api3_get_DAO($entity);
279 * Function to return the DAO of the function or Entity
280 * @param String $name either a function of the api (civicrm_{entity}_create or the entity name
281 * return the DAO name to manipulate this function
282 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
283 * @return mixed|string
285 function _civicrm_api3_get_DAO($name) {
286 if (strpos($name, 'civicrm_api3') !== FALSE) {
287 $last = strrpos($name, '_');
288 // len ('civicrm_api3_') == 13
289 $name = substr($name, 13, $last - 13);
292 if (strtolower($name) == 'individual' ||
strtolower($name) == 'household' ||
strtolower($name) == 'organization') {
296 //hack to deal with incorrectly named BAO/DAO - see CRM-10859 -
297 // several of these have been removed but am not confident mailing_recipients is
298 // tests so have not tackled.
299 // correct approach for im is unclear
300 if($name == 'mailing_recipients' ||
$name == 'MailingRecipients'){
301 return 'CRM_Mailing_BAO_Recipients';
303 if(strtolower($name) == 'im'){
304 return 'CRM_Core_BAO_IM';
306 return CRM_Core_DAO_AllCoreTables
::getFullName(_civicrm_api_get_camel_name($name, 3));
310 * Function to return the DAO of the function or Entity
311 * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
312 * return the DAO name to manipulate this function
313 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
316 function _civicrm_api3_get_BAO($name) {
317 $dao = _civicrm_api3_get_DAO($name);
321 $bao = str_replace("DAO", "BAO", $dao);
322 $file = strtr($bao, '_', '/') . '.php';
323 // Check if this entity actually has a BAO. Fall back on the DAO if not.
324 return stream_resolve_include_path($file) ?
$bao : $dao;
328 * Recursive function to explode value-separated strings into arrays
331 function _civicrm_api3_separate_values(&$values) {
332 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
333 foreach ($values as $key => & $value) {
334 if (is_array($value)) {
335 _civicrm_api3_separate_values($value);
337 elseif (is_string($value)) {
338 if($key == 'case_type_id'){// this is to honor the way case API was originally written
339 $value = trim(str_replace($sp, ',', $value), ',');
341 elseif (strpos($value, $sp) !== FALSE) {
342 $value = explode($sp, trim($value, $sp));
349 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
350 * rather than DAO->fields
352 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
354 * Note this is used by BAO type create functions - eg. contribution
355 * @param string $entity
356 * @param array $params
357 * @param array $values
359 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
360 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
361 $fields = $fields['values'];
362 _civicrm_api3_store_values($fields, $params, $values);
366 * @param array $fields
367 * @param array $params
368 * @param array $values
370 * @return Bool $valueFound
372 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
375 $keys = array_intersect_key($params, $fields);
376 foreach ($keys as $name => $value) {
377 if ($name !== 'id') {
378 $values[$name] = $value;
386 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
387 * This is a generic function for those functions that call it
389 * At the moment only called by contact we should extend to contribution &
390 * others that use the query object. Note that this function passes permission information in.
393 * * Ideally this would be merged with _civicrm_get_query_object but we need to resolve differences in what the
396 * @param array $params as passed into api get or getcount function
397 * @param array $additional_options
398 * @param bool $getCount are we just after the count
401 * @internal param array $options array of options (so we can modify the filter)
403 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
405 // Convert id to e.g. contact_id
406 if (empty($params[$entity . '_id']) && isset($params['id'])) {
407 $params[$entity . '_id'] = $params['id'];
409 unset($params['id']);
411 $options = _civicrm_api3_get_options_from_params($params, TRUE);
413 $inputParams = array_merge(
414 CRM_Utils_Array
::value('input_params', $options, array()),
415 CRM_Utils_Array
::value('input_params', $additional_options, array())
417 $returnProperties = array_merge(
418 CRM_Utils_Array
::value('return', $options, array()),
419 CRM_Utils_Array
::value('return', $additional_options, array())
421 if(empty($returnProperties)){
422 $returnProperties = NULL;
424 if(!empty($params['check_permissions'])){
425 // we will filter query object against getfields
426 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
427 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
428 $fields['values'][$entity . '_id'] = array();
429 $varsToFilter = array('returnProperties', 'inputParams');
430 foreach ($varsToFilter as $varToFilter){
431 if(!is_array($
$varToFilter)){
434 //I was going to throw an exception rather than silently filter out - but
435 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
436 //so we are silently ignoring parts of their request
437 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
438 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
441 $options = array_merge($options,$additional_options);
442 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
443 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
444 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
445 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
449 $returnProperties = NULL;
452 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
453 foreach ($newParams as &$newParam) {
454 if($newParam[1] == '=' && is_array($newParam[2])) {
455 // we may be looking at an attempt to use the 'IN' style syntax
456 // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax
457 $sqlFilter = CRM_Core_DAO
::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
459 $newParam[1] = key($newParam[2]);
460 $newParam[2] = $sqlFilter;
465 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
466 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
477 if ($getCount) { // only return the count of contacts
485 * get dao query object based on input params
486 * Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the
489 * @param array $params
490 * @param string $mode
491 * @param string $entity
492 * @return CRM_Core_DAO query object
494 function _civicrm_api3_get_query_object($params, $mode, $entity) {
495 $options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
496 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
497 $offset = CRM_Utils_Array
::value('offset', $options);
498 $rowCount = CRM_Utils_Array
::value('limit', $options);
499 $inputParams = CRM_Utils_Array
::value('input_params', $options, array());
500 $returnProperties = CRM_Utils_Array
::value('return', $options, NULL);
501 if (empty($returnProperties)) {
502 $returnProperties = CRM_Contribute_BAO_Query
::defaultReturnProperties($mode);
505 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
506 $query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL,
509 list($select, $from, $where, $having) = $query->query();
511 $sql = "$select $from $where $having";
514 $sql .= " ORDER BY $sort ";
516 if(!empty($rowCount)) {
517 $sql .= " LIMIT $offset, $rowCount ";
519 $dao = CRM_Core_DAO
::executeQuery($sql);
520 return array($dao, $query);
524 * Function transfers the filters being passed into the DAO onto the params object
526 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
527 $entity = substr($dao->__table
, 8);
529 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
531 $fields = array_intersect(array_keys($allfields), array_keys($params));
532 if (isset($params[$entity . "_id"])) {
533 //if entity_id is set then treat it as ID (will be overridden by id if set)
534 $dao->id
= $params[$entity . "_id"];
537 $options = _civicrm_api3_get_options_from_params($params);
538 //apply options like sort
539 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
541 //accept filters like filter.activity_date_time_high
542 // std is now 'filters' => ..
543 if (strstr(implode(',', array_keys($params)), 'filter')) {
544 if (isset($params['filters']) && is_array($params['filters'])) {
545 foreach ($params['filters'] as $paramkey => $paramvalue) {
546 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
550 foreach ($params as $paramkey => $paramvalue) {
551 if (strstr($paramkey, 'filter')) {
552 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
557 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
558 // support for other syntaxes is discussed in ticket but being put off for now
559 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
564 foreach ($fields as $field) {
565 if (is_array($params[$field])) {
566 //get the actual fieldname from db
567 $fieldName = $allfields[$field]['name'];
568 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
570 $dao->whereAdd($where);
575 $daoFieldName = $allfields[$field]['name'];
576 if (empty($daoFieldName)) {
577 throw new API_Exception("Failed to determine field name for \"$field\"");
579 $dao->{$daoFieldName} = $params[$field];
582 $dao->$field = $params[$field];
586 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
588 $options['return']['id'] = TRUE;// ensure 'id' is included
589 $allfields = _civicrm_api3_get_unique_name_array($dao);
590 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
591 foreach ($returnMatched as $returnValue) {
592 $dao->selectAdd($returnValue);
595 $unmatchedFields = array_diff(// not already matched on the field names
596 array_keys($options['return']),
600 $returnUniqueMatched = array_intersect(
602 array_flip($allfields)// but a match for the field keys
604 foreach ($returnUniqueMatched as $uniqueVal){
605 $dao->selectAdd($allfields[$uniqueVal]);
608 $dao->setApiFilter($params);
612 * Apply filters (e.g. high, low) to DAO object (prior to find)
613 * @param string $filterField field name of filter
614 * @param string $filterValue field value of filter
615 * @param object $dao DAO object
617 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
618 if (strstr($filterField, 'high')) {
619 $fieldName = substr($filterField, 0, -5);
620 $dao->whereAdd("($fieldName <= $filterValue )");
622 if (strstr($filterField, 'low')) {
623 $fieldName = substr($filterField, 0, -4);
624 $dao->whereAdd("($fieldName >= $filterValue )");
626 if($filterField == 'is_current' && $filterValue == 1){
627 $todayStart = date('Ymd000000', strtotime('now'));
628 $todayEnd = date('Ymd235959', strtotime('now'));
629 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
630 if(property_exists($dao, 'is_active')){
631 $dao->whereAdd('is_active = 1');
637 * Get sort, limit etc options from the params - supporting old & new formats.
638 * get returnproperties for legacy
640 * @param array $params params array as passed into civicrm_api
641 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
642 * for legacy report & return a unique fields array
644 * @param string $entity
645 * @param string $action
647 * @return array $options options extracted from params
649 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
651 $sort = CRM_Utils_Array
::value('sort', $params, 0);
652 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
653 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
655 $offset = CRM_Utils_Array
::value('offset', $params, 0);
656 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
657 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
658 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
660 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
661 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
662 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
664 if (is_array(CRM_Utils_Array
::value('options', $params))) {
665 // is count is set by generic getcount not user
666 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
667 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
668 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
669 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
672 $returnProperties = array();
673 // handle the format return =sort_name,display_name...
674 if (array_key_exists('return', $params)) {
675 if (is_array($params['return'])) {
676 $returnProperties = array_fill_keys($params['return'], 1);
679 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
680 $returnProperties = array_fill_keys($returnProperties, 1);
683 if ($entity && $action =='get') {
684 if (CRM_Utils_Array
::value('id',$returnProperties)) {
685 $returnProperties[$entity . '_id'] = 1;
686 unset($returnProperties['id']);
688 switch (trim(strtolower($sort))){
692 $sort = str_replace('id', $entity . '_id',$sort);
697 'offset' => CRM_Utils_Rule
::integer($offset) ?
$offset : NULL,
698 'sort' => CRM_Utils_Rule
::string($sort) ?
$sort : NULL,
699 'limit' => CRM_Utils_Rule
::integer($limit) ?
$limit : NULL,
700 'is_count' => $is_count,
701 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
704 if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
705 throw new API_Exception('invalid string in sort options');
711 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
712 // if the queryobject is being used this should be used
713 $inputParams = array();
714 $legacyreturnProperties = array();
716 'sort', 'offset', 'rowCount', 'options','return',
718 foreach ($params as $n => $v) {
719 if (substr($n, 0, 7) == 'return.') {
720 $legacyreturnProperties[substr($n, 7)] = $v;
722 elseif ($n == 'id') {
723 $inputParams[$entity. '_id'] = $v;
725 elseif (in_array($n, $otherVars)) {}
727 $inputParams[$n] = $v;
728 if ($v && !is_array($v) && stristr($v, 'SELECT')) {
729 throw new API_Exception('invalid string');
733 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
734 $options['input_params'] = $inputParams;
739 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
741 * @param array $params params array as passed into civicrm_api
742 * @param object $dao DAO object
745 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
747 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
748 if(!$options['is_count']) {
749 if(!empty($options['limit'])) {
750 $dao->limit((int)$options['offset'], (int)$options['limit']);
752 if (!empty($options['sort'])) {
753 $dao->orderBy($options['sort']);
759 * build fields array. This is the array of fields as it relates to the given DAO
760 * returns unique fields as keys by default but if set but can return by DB fields
762 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
763 $fields = $bao->fields();
765 if(!CRM_Utils_Array
::value('id', $fields)){
766 $entity = _civicrm_api_get_entity_name_from_dao($bao);
767 $fields['id'] = $fields[$entity . '_id'];
768 unset($fields[$entity . '_id']);
773 foreach ($fields as $field) {
774 $dbFields[$field['name']] = $field;
780 * build fields array. This is the array of fields as it relates to the given DAO
781 * returns unique fields as keys by default but if set but can return by DB fields
783 function _civicrm_api3_get_unique_name_array(&$bao) {
784 $fields = $bao->fields();
785 foreach ($fields as $field => $values) {
786 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
788 return $uniqueFields;
792 * Converts an DAO object to an array
794 * @param object $dao (reference )object to convert
795 * @param null $params
796 * @param bool $uniqueFields
797 * @param string $entity
801 * @params array of arrays (key = id) of array of fields
806 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) {
808 if(isset($params['options']) && CRM_Utils_Array
::value('is_count', $params['options'])) {
809 return $dao->count();
814 if ($autoFind && !$dao->find()) {
818 if(isset($dao->count
)) {
821 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
822 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
823 foreach ($params['return'] as $return) {
824 if (substr($return, 0, 6) == 'custom') {
831 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
833 while ($dao->fetch()) {
835 foreach ($fields as $key) {
836 if (array_key_exists($key, $dao)) {
837 // not sure on that one
838 if ($dao->$key !== NULL) {
839 $tmp[$key] = $dao->$key;
843 $result[$dao->id
] = $tmp;
844 if (!empty($custom)) {
845 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
854 * Converts an object to an array
856 * @param object $dao (reference) object to convert
857 * @param array $values (reference) array
858 * @param array|bool $uniqueFields
864 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
866 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
867 foreach ($fields as $key => $value) {
868 if (array_key_exists($key, $dao)) {
869 $values[$key] = $dao->$key;
875 * Wrapper for _civicrm_object_to_array when api supports unique fields
877 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
878 return _civicrm_api3_object_to_array($dao, $values, TRUE);
883 * @param array $params
884 * @param array $values
885 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
886 * @param string $entityId ID of entity per $extends
888 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
889 $values['custom'] = array();
890 $checkCheckBoxField = FALSE;
892 if(in_array($extends, array('Household', 'Individual', 'Organization'))) {
896 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'create'));
897 if(!$fields['is_error']) {
898 // not sure if fields could be error - maybe change to using civicrm_api3 wrapper later - this is conservative
899 $fields = $fields['values'];
900 $checkCheckBoxField = TRUE;
903 foreach ($params as $key => $value) {
904 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
905 if ($customFieldID && (!IS_NULL($value))) {
906 if ($checkCheckBoxField && !empty($fields['custom_' . $customFieldID]) && $fields['custom_' . $customFieldID]['html_type'] == 'CheckBox') {
907 formatCheckBoxField($value, 'custom_' . $customFieldID, $entity);
909 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
910 $value, $extends, $customValueID, $entityId, FALSE, FALSE
917 * we can't rely on downstream to add separators to checkboxes so we'll check here. We should look at pushing to BAO function
918 * and / or validate function but this is a safe place for now as it has massive test coverage & we can keep the change very specific
919 * note that this is specifically tested in the GRANT api test case so later refactoring should use that as a checking point
921 * We will only alter the value if we are sure that changing it will make it correct - if it appears wrong but does not appear to have a clear fix we
922 * don't touch - lots of very cautious code in here
924 * The resulting array should look like
930 * OR one or more keys wrapped in a CRM_Core_DAO::VALUE_SEPARATOR - either it accepted by the receiving function
932 * @todo - we are probably skipping handling disabled options as presumably getoptions is not giving us them. This should be non-regressive but might
935 * @param $checkboxFieldValue
936 * @param $customFieldLabel
940 function formatCheckBoxField(&$checkboxFieldValue, $customFieldLabel, $entity) {
942 if (is_string($checkboxFieldValue) && stristr($checkboxFieldValue, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
943 // we can assume it's pre-formatted
946 $options = civicrm_api($entity, 'getoptions', array('field' => $customFieldLabel, 'version' => 3));
947 if (!empty($options['is_error'])) {
948 //the check is precautionary - can probably be removed later
952 $options = $options['values'];
954 if (is_array($checkboxFieldValue)) {
955 foreach ($checkboxFieldValue as $key => $value) {
956 if (!array_key_exists($key, $options)) {
961 // we have been passed an array that is already in the 'odd' custom field format
966 // so we either have an array that is not keyed by the value or we have a string that doesn't hold separators
967 // if the array only has one item we'll treat it like any other string
968 if (is_array($checkboxFieldValue) && count($checkboxFieldValue) == 1) {
969 $possibleValue = reset($checkboxFieldValue);
971 if (is_string($checkboxFieldValue)) {
972 $possibleValue = $checkboxFieldValue;
974 if (isset($possibleValue) && array_key_exists($possibleValue, $options)) {
975 $checkboxFieldValue = CRM_Core_DAO
::VALUE_SEPARATOR
. $possibleValue . CRM_Core_DAO
::VALUE_SEPARATOR
;
978 elseif (is_array($checkboxFieldValue)) {
979 // so this time around we are considering the values in the array
980 $possibleValues = $checkboxFieldValue;
983 elseif (stristr($checkboxFieldValue, ',')) {
985 //lets see if we should separate it - we do this near the end so we
986 // ensure we have already checked that the comma is not part of a legitimate match
987 // and of course, we don't make any changes if we don't now have matches
988 $possibleValues = explode(',', $checkboxFieldValue);
991 // run out of ideas as to what the format might be - if it's a string it doesn't match with or without the ','
995 foreach ($possibleValues as $index => $possibleValue) {
996 if (array_key_exists($possibleValue, $options)) {
997 // do nothing - we will leave formatValue set to true unless another value is not found (which would cause us to ignore the whole value set)
999 elseif (array_key_exists(trim($possibleValue), $options)) {
1000 $possibleValues[$index] = trim($possibleValue);
1003 $formatValue = FALSE;
1007 $checkboxFieldValue = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $possibleValues) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1013 * This function ensures that we have the right input parameters
1015 * This function is only called when $dao is passed into verify_mandatory.
1016 * The practice of passing $dao into verify_mandatory turned out to be
1017 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
1018 * api level. Hence the intention is to remove this function
1019 * & the associated param from viery_mandatory
1021 * @param array $params Associative array of property name/value
1022 * pairs to insert in new history.
1024 * @param bool $return
1026 * @daoName string DAO to check params agains
1028 * @return bool should the missing fields be returned as an array (core error created as default)
1030 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
1033 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
1034 //@deprecated - see notes
1035 if (isset($params['extends'])) {
1036 if (($params['extends'] == 'Activity' ||
1037 $params['extends'] == 'Phonecall' ||
1038 $params['extends'] == 'Meeting' ||
1039 $params['extends'] == 'Group' ||
1040 $params['extends'] == 'Contribution'
1042 ($params['style'] == 'Tab')
1044 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
1048 $dao = new $daoName();
1049 $fields = $dao->fields();
1052 foreach ($fields as $k => $v) {
1053 if ($v['name'] == 'id') {
1057 if (CRM_Utils_Array
::value('required', $v)) {
1058 // 0 is a valid input for numbers, CRM-8122
1059 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
1065 if (!empty($missing)) {
1066 if (!empty($return)) {
1070 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
1078 * Check permissions for a given API call.
1080 * @param $entity string API entity being accessed
1081 * @param $action string API action being performed
1082 * @param $params array params of the API call
1083 * @param $throw deprecated bool whether to throw exception instead of returning false
1086 * @return bool whether the current API user has the permission to make the call
1088 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
1089 // return early unless we’re told explicitly to do the permission check
1090 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
1094 require_once 'CRM/Core/DAO/permissions.php';
1095 $permissions = _civicrm_api3_permissions($entity, $action, $params);
1097 // $params might’ve been reset by the alterAPIPermissions() hook
1098 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
1102 if (!CRM_Core_Permission
::check($permissions)) {
1104 if(is_array($permissions)) {
1105 $permissions = implode(' and ', $permissions);
1107 throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
1110 //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
1111 // in tests & that should be tidied up
1120 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
1122 * @param string $bao_name name of BAO
1123 * @param array $params params from api
1124 * @param bool $returnAsSuccess return in api success format
1125 * @param string $entity
1129 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
1130 $bao = new $bao_name();
1131 _civicrm_api3_dao_set_filter($bao, $params, TRUE, $entity);
1132 if ($returnAsSuccess) {
1133 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity, 'get');
1136 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
1141 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
1142 * @param string $bao_name Name of BAO Class
1143 * @param array $params parameters passed into the api call
1144 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
1147 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
1149 $args = array(&$params);
1150 if (!empty($entity)) {
1151 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
1155 if (method_exists($bao_name, 'create')) {
1157 $fct_name = $bao_name . '::' . $fct;
1158 $bao = call_user_func_array(array($bao_name, $fct), $args);
1160 elseif (method_exists($bao_name, 'add')) {
1162 $fct_name = $bao_name . '::' . $fct;
1163 $bao = call_user_func_array(array($bao_name, $fct), $args);
1166 $fct_name = '_civicrm_api3_basic_create_fallback';
1167 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1170 if (is_null($bao)) {
1171 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1173 elseif (is_a($bao, 'CRM_Core_Error')) {
1174 //some wierd circular thing means the error takes itself as an argument
1175 $msg = $bao->getMessages($bao);
1176 // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1177 // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1178 // so we need to reset the error object here to avoid getting concatenated errors
1179 //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1180 CRM_Core_Error
::singleton()->reset();
1181 throw new API_Exception($msg);
1185 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
1186 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1191 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1193 * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1194 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1196 * @param string $bao_name
1197 * @param array $params
1199 * @throws API_Exception
1200 * @return CRM_Core_DAO|NULL an instance of the BAO
1202 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1203 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName(get_parent_class($bao_name));
1204 if (empty($entityName)) {
1205 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1206 'class_name' => $bao_name,
1209 $hook = empty($params['id']) ?
'create' : 'edit';
1211 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
1212 $instance = new $bao_name();
1213 $instance->copyValues($params);
1215 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
1221 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1222 * if api::del doesn't exist it will try DAO delete method
1224 function _civicrm_api3_basic_delete($bao_name, &$params) {
1226 civicrm_api3_verify_mandatory($params, NULL, array('id'));
1227 $args = array(&$params['id']);
1228 if (method_exists($bao_name, 'del')) {
1229 $bao = call_user_func_array(array($bao_name, 'del'), $args);
1230 if ($bao !== FALSE) {
1231 return civicrm_api3_create_success(TRUE);
1233 throw new API_Exception('Could not delete entity id ' . $params['id']);
1235 elseif (method_exists($bao_name, 'delete')) {
1236 $dao = new $bao_name();
1237 $dao->id
= $params['id'];
1239 while ($dao->fetch()) {
1241 return civicrm_api3_create_success();
1245 throw new API_Exception('Could not delete entity id ' . $params['id']);
1249 throw new API_Exception('no delete method found');
1253 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1254 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1256 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1257 * @param string $entity e.g membership, event
1259 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1260 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1261 * @param string $subName - Subtype of entity
1263 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1264 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1265 CRM_Core_DAO
::$_nullObject,
1271 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1272 $customValues = array();
1273 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1274 if (!empty($customValues)) {
1275 foreach ($customValues as $key => $val) {
1276 if (strstr($key, '_id')) {
1277 $idkey = substr($key, 0, -3);
1278 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1279 $returnArray[$key] = $val;
1282 // per standard - return custom_fieldID
1283 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1285 //not standard - but some api did this so guess we should keep - cheap as chips
1286 $returnArray[$key] = $val;
1293 * Validate fields being passed into API. This function relies on the getFields function working accurately
1294 * for the given API. If error mode is set to TRUE then it will also check
1297 * As of writing only date was implemented.
1298 * @param string $entity
1299 * @param string $action
1300 * @param array $params -
1301 * @param array $fields response from getfields all variables are the same as per civicrm_api
1302 * @param bool $errorMode errorMode do intensive post fail checks?
1305 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1306 $fields = array_intersect_key($fields, $params);
1307 foreach ($fields as $fieldName => $fieldInfo) {
1308 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1309 case CRM_Utils_Type
::T_INT
:
1310 //field is of type integer
1311 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1316 //field is of type date or datetime
1317 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1321 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1324 case CRM_Utils_Type
::T_STRING
:
1325 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1328 case CRM_Utils_Type
::T_MONEY
:
1329 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1330 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1334 // intensive checks - usually only called after DB level fail
1335 if (!empty($errorMode) && strtolower($action) == 'create') {
1336 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1337 if (CRM_Utils_Array
::value($fieldName, $params)) {
1338 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1340 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1341 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1344 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1345 $params['entity'] = $entity;
1346 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1353 * Validate date fields being passed into API.
1354 * It currently converts both unique fields and DB field names to a mysql date.
1355 * @todo - probably the unique field handling & the if exists handling is now done before this
1356 * function is reached in the wrapper - can reduce this code down to assume we
1357 * are only checking the passed in field
1359 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1360 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1362 * @param array $params params from civicrm_api
1363 * @param string $fieldName uniquename of field being checked
1366 * @internal param array $fieldinfo array of fields from getfields function
1368 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1369 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1370 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1371 //accept 'whatever strtotime accepts
1372 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1373 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1375 $format = ($fieldInfo['type'] == CRM_Utils_Type
::T_DATE
) ?
'Ymd000000' : 'YmdHis';
1376 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']], NULL, FALSE, $format);
1378 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array
::value($fieldName, $params)) {
1379 //If the unique field name differs from the db name & is set handle it here
1380 if (strtotime($params[$fieldName]) === FALSE) {
1381 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1383 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1388 * Validate foreign constraint fields being passed into API.
1390 * @param array $params params from civicrm_api
1391 * @param string $fieldName uniquename of field being checked
1394 * @internal param array $fieldinfo array of fields from getfields function
1396 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1397 $dao = new $fieldInfo['FKClassName'];
1398 $dao->id
= $params[$fieldName];
1400 $dao->selectAdd('id');
1401 if (!$dao->find()) {
1402 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1407 * Validate foreign constraint fields being passed into API.
1409 * @param array $params params from civicrm_api
1410 * @param string $fieldName uniquename of field being checked
1413 * @internal param array $fieldinfo array of fields from getfields function
1415 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1416 $existing = civicrm_api($params['entity'], 'get', array(
1417 'version' => $params['version'],
1418 $fieldName => $params[$fieldName],
1420 // an entry already exists for this unique field
1421 if ($existing['count'] == 1) {
1422 // question - could this ever be a security issue?
1423 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1428 * Generic implementation of the "replace" action.
1430 * Replace the old set of entities (matching some given keys) with a new set of
1431 * entities (matching the same keys).
1433 * Note: This will verify that 'values' is present, but it does not directly verify
1434 * any other parameters.
1436 * @param string $entity entity name
1437 * @param array $params params from civicrm_api, including:
1438 * - 'values': an array of records to save
1439 * - all other items: keys which identify new/pre-existing records
1442 function _civicrm_api3_generic_replace($entity, $params) {
1444 $transaction = new CRM_Core_Transaction();
1446 if (!is_array($params['values'])) {
1447 throw new Exception("Mandatory key(s) missing from params array: values");
1450 // Extract the keys -- somewhat scary, don't think too hard about it
1451 $baseParams = _civicrm_api3_generic_replace_base_params($params);
1453 // Lookup pre-existing records
1454 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1455 if (civicrm_error($preexisting)) {
1456 $transaction->rollback();
1457 return $preexisting;
1460 // Save the new/updated records
1462 foreach ($params['values'] as $replacement) {
1463 // Sugar: Don't force clients to duplicate the 'key' data
1464 $replacement = array_merge($baseParams, $replacement);
1465 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1466 $create = civicrm_api($entity, $action, $replacement);
1467 if (civicrm_error($create)) {
1468 $transaction->rollback();
1471 foreach ($create['values'] as $entity_id => $entity_value) {
1472 $creates[$entity_id] = $entity_value;
1476 // Remove stale records
1477 $staleIDs = array_diff(
1478 array_keys($preexisting['values']),
1479 array_keys($creates)
1481 foreach ($staleIDs as $staleID) {
1482 $delete = civicrm_api($entity, 'delete', array(
1483 'version' => $params['version'],
1486 if (civicrm_error($delete)) {
1487 $transaction->rollback();
1492 return civicrm_api3_create_success($creates, $params);
1494 catch(PEAR_Exception
$e) {
1495 $transaction->rollback();
1496 return civicrm_api3_create_error($e->getMessage());
1498 catch(Exception
$e) {
1499 $transaction->rollback();
1500 return civicrm_api3_create_error($e->getMessage());
1509 function _civicrm_api3_generic_replace_base_params($params) {
1510 $baseParams = $params;
1511 unset($baseParams['values']);
1512 unset($baseParams['sequential']);
1513 unset($baseParams['options']);
1518 * returns fields allowable by api
1520 * @param $entity string Entity to query
1521 * @param bool $unique index by unique fields?
1522 * @param array $params
1526 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1528 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1529 $dao = _civicrm_api3_get_DAO($entity);
1534 $fields = $d->fields();
1535 // replace uniqueNames by the normal names as the key
1536 if (empty($unique)) {
1537 foreach ($fields as $name => & $field) {
1538 //getting rid of unused attributes
1539 foreach ($unsetIfEmpty as $attr) {
1540 if (empty($field[$attr])) {
1541 unset($field[$attr]);
1544 if ($name == $field['name']) {
1547 if (array_key_exists($field['name'], $fields)) {
1548 $field['error'] = 'name conflict';
1549 // it should never happen, but better safe than sorry
1552 $fields[$field['name']] = $field;
1553 $fields[$field['name']]['uniqueName'] = $name;
1554 unset($fields[$name]);
1557 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1562 * Return an array of fields for a given entity - this is the same as the BAO function but
1563 * fields are prefixed with 'custom_' to represent api params
1565 function _civicrm_api_get_custom_fields($entity, &$params) {
1566 $customfields = array();
1567 $entity = _civicrm_api_get_camel_name($entity);
1568 if (strtolower($entity) == 'contact') {
1569 // Use sub-type if available, otherwise stick with 'Contact'
1570 $entity = CRM_Utils_Array
::value('contact_type', $params);
1572 $retrieveOnlyParent = FALSE;
1573 // we could / should probably test for other subtypes here - e.g. activity_type_id
1574 if($entity == 'Contact'){
1575 empty($params['contact_sub_type']);
1577 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1580 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1582 $retrieveOnlyParent,
1586 // find out if we have any requests to resolve options
1587 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1588 if(!is_array($getoptions)){
1589 $getoptions = array($getoptions);
1592 foreach ($customfields as $key => $value) {
1593 // Regular fields have a 'name' property
1594 $value['name'] = 'custom_' . $key;
1595 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1596 $customfields['custom_' . $key] = $value;
1597 if (in_array('custom_' . $key, $getoptions)) {
1598 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1600 unset($customfields[$key]);
1602 return $customfields;
1605 * Translate the custom field data_type attribute into a std 'type'
1607 function _getStandardTypeFromCustomDataType($dataType) {
1609 'String' => CRM_Utils_Type
::T_STRING
,
1610 'Int' => CRM_Utils_Type
::T_INT
,
1611 'Money' => CRM_Utils_Type
::T_MONEY
,
1612 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1613 'Float' => CRM_Utils_Type
::T_FLOAT
,
1614 'Date' => CRM_Utils_Type
::T_DATE
,
1615 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1616 'StateProvince' => CRM_Utils_Type
::T_INT
,
1617 'File' => CRM_Utils_Type
::T_STRING
,
1618 'Link' => CRM_Utils_Type
::T_STRING
,
1619 'ContactReference' => CRM_Utils_Type
::T_INT
,
1620 'Country' => CRM_Utils_Type
::T_INT
,
1622 return $mapping[$dataType];
1625 * Return array of defaults for the given API (function is a wrapper on getfields)
1627 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1628 $defaults = array();
1630 foreach ($fields as $field => $values) {
1631 if (isset($values['api.default'])) {
1632 $defaults[$field] = $values['api.default'];
1639 * Return array of defaults for the given API (function is a wrapper on getfields)
1641 function _civicrm_api3_getrequired($apiRequest, $fields) {
1642 $required = array('version');
1644 foreach ($fields as $field => $values) {
1645 if (CRM_Utils_Array
::value('api.required', $values)) {
1646 $required[] = $field;
1653 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1654 * If multiple aliases the last takes precedence
1656 * Function also swaps unique fields for non-unique fields & vice versa.
1658 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1659 foreach ($fields as $field => $values) {
1660 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1661 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1662 // if aliased field is not set we try to use field alias
1663 if (!isset($apiRequest['params'][$field])) {
1664 foreach ($values['api.aliases'] as $alias) {
1665 if (isset($apiRequest['params'][$alias])) {
1666 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1668 //unset original field nb - need to be careful with this as it may bring inconsistencies
1669 // out of the woodwork but will be implementing only as _spec function extended
1670 unset($apiRequest['params'][$alias]);
1674 if (!isset($apiRequest['params'][$field])
1675 && CRM_Utils_Array
::value('name', $values)
1676 && $field != $values['name']
1677 && isset($apiRequest['params'][$values['name']])
1679 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1680 // note that it would make sense to unset the original field here but tests need to be in place first
1682 if (!isset($apiRequest['params'][$field])
1684 && $field != $uniqueName
1685 && array_key_exists($uniqueName, $apiRequest['params'])
1688 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1689 // note that it would make sense to unset the original field here but tests need to be in place first
1696 * Validate integer fields being passed into API.
1697 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1699 * @param array $params params from civicrm_api
1700 * @param string $fieldName uniquename of field being checked
1703 * @throws API_Exception
1704 * @internal param array $fieldinfo array of fields from getfields function
1706 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1707 //if fieldname exists in params
1708 if (CRM_Utils_Array
::value($fieldName, $params)) {
1709 // if value = 'user_contact_id' (or similar), replace value with contact id
1710 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1711 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1712 if ('unknown-user' === $realContactId) {
1713 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1714 } elseif (is_numeric($realContactId)) {
1715 $params[$fieldName] = $realContactId;
1718 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1719 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1722 // After swapping options, ensure we have an integer(s)
1723 foreach ((array) ($params[$fieldName]) as $value) {
1724 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1725 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1729 // Check our field length
1730 if(is_string($params[$fieldName]) &&
1731 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1732 && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1734 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1735 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1742 * Determine a contact ID using a string expression
1744 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1745 * @return int|NULL|'unknown-user'
1747 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1748 //if value = 'user_contact_id' replace value with logged in user id
1749 if ($contactIdExpr == "user_contact_id") {
1750 return CRM_Core_Session
::getLoggedInContactID();
1752 elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1753 $config = CRM_Core_Config
::singleton();
1755 $ufID = $config->userSystem
->getUfId($matches[1]);
1757 return 'unknown-user';
1760 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1762 return 'unknown-user';
1771 * Validate html (check for scripting attack)
1776 * @throws API_Exception
1778 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1779 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1780 if (!CRM_Utils_Rule
::xssString($value)) {
1781 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1787 * Validate string fields being passed into API.
1788 * @param array $params params from civicrm_api
1789 * @param string $fieldName uniquename of field being checked
1792 * @throws API_Exception
1794 * @internal param array $fieldinfo array of fields from getfields function
1796 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1797 // If fieldname exists in params
1798 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1799 if(!is_array($value)){
1800 $value = (string) $value;
1803 //@todo what do we do about passed in arrays. For many of these fields
1804 // the missing piece of functionality is separating them to a separated string
1805 // & many save incorrectly. But can we change them wholesale?
1808 if (!CRM_Utils_Rule
::xssString($value)) {
1809 throw new Exception('Illegal characters in input (potential scripting attack)');
1811 if ($fieldName == 'currency') {
1812 if (!CRM_Utils_Rule
::currencyCode($value)) {
1813 throw new Exception("Currency not a valid code: $value");
1816 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options']) ||
!empty($fieldInfo['enumValues'])) {
1817 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1819 // Check our field length
1820 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1821 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1822 2100, array('field' => $fieldName)
1829 * Validate & swap out any pseudoconstants / options
1831 * @param $params: api parameters
1832 * @param $entity: api entity name
1833 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1834 * @param $fieldInfo: getfields meta-data
1836 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1837 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1839 if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1840 // we need to get the options from the entity the field relates to
1841 $entity = $fieldInfo['entity'];
1843 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1844 $options = CRM_Utils_Array
::value('values', $options, array());
1847 // If passed a value-separated string, explode to an array, then re-implode after matching values
1849 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1850 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1853 // If passed multiple options, validate each
1854 if (is_array($params[$fieldName])) {
1855 foreach ($params[$fieldName] as &$value) {
1856 if (!is_array($value)) {
1857 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1860 // TODO: unwrap the call to implodePadded from the conditional and do it always
1861 // need to verify that this is safe and doesn't break anything though.
1862 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1864 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1868 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1873 * Validate & swap a single option value for a field
1875 * @param $value: field value
1876 * @param $options: array of options for this field
1877 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1878 * @throws API_Exception
1880 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1881 // If option is a key, no need to translate
1882 if (array_key_exists($value, $options)) {
1886 // Translate value into key
1887 $newValue = array_search($value, $options);
1888 if ($newValue !== FALSE) {
1892 // Case-insensitive matching
1893 $newValue = strtolower($value);
1894 $options = array_map("strtolower", $options);
1895 $newValue = array_search($newValue, $options);
1896 if ($newValue === FALSE) {
1897 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1903 * Returns the canonical name of a field
1904 * @param $entity: api entity name (string should already be standardized - no camelCase)
1905 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1907 * @return (string|bool) fieldName or FALSE if the field does not exist
1909 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1910 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1913 if ($fieldName == "{$entity}_id") {
1916 $result = civicrm_api($entity, 'getfields', array(
1918 'action' => 'create',
1920 $meta = $result['values'];
1921 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1922 $fieldName = $fieldName . '_id';
1924 if (isset($meta[$fieldName])) {
1925 return $meta[$fieldName]['name'];
1927 foreach ($meta as $info) {
1928 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1929 return $info['name'];
1931 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1932 return $info['name'];