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 check
52 * @param array $daoName string DAO to check for required fields (create functions only)
53 * @param array $keys list of required fields options. One of the options is required
54 * @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 * @return null or throws error if there the required fields not present
78 * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
80 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
81 ), $verifyDAO = TRUE) {
84 if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
85 $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
86 if (!is_array($unmatched)) {
91 if (!empty($params['id'])) {
92 $keys = array('version');
95 if (!in_array('version', $keys)) {
96 // required from v3 onwards
100 foreach ($keys as $key) {
101 if (is_array($key)) {
103 $optionset = array();
104 foreach ($key as $subkey) {
105 if (!array_key_exists($subkey, $params) ||
empty($params[$subkey])) {
106 $optionset[] = $subkey;
109 // as long as there is one match then we don't need to rtn anything
113 if (empty($match) && !empty($optionset)) {
114 $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
118 if (!array_key_exists($key, $params) ||
empty($params[$key])) {
123 if (!empty($unmatched)) {
124 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
131 * @param <type> $data
132 * @param object $dao DAO / BAO object to be freed here
136 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
137 //fix me - $dao should be param 4 & 3 should be $apiRequest
138 if (is_object($dao)) {
142 if (is_array($dao)) {
143 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
145 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], TRUE);
147 catch(Exception
$e) {
148 $msg = $e->getMessage();
152 $data['is_error'] = 1;
153 $data['error_message'] = $msg;
154 // we will show sql to privelledged user only (not sure of a specific
155 // security hole here but seems sensible - perhaps should apply to the trace as well?
156 if(isset($data['sql']) && CRM_Core_Permission
::check('Administer CiviCRM')) {
157 $data['debug_information'] = $data['sql'];
159 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array
::value('api.has_parent', $dao['params'])) {
160 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
161 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
167 * Format array in result output styple
169 * @param array $values values generated by API operation (the result)
170 * @param array $params parameters passed into API call
171 * @param string $entity the entity being acted on
172 * @param string $action the action passed to the API
173 * @param object $dao DAO object to be freed here
174 * @param array $extraReturnValues additional values to be added to top level of result array(
175 * - this param is currently used for legacy behaviour support
177 * @return array $result
179 function civicrm_api3_create_success($values = 1, $params = array(
180 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
182 $result['is_error'] = 0;
183 //lets set the ['id'] field if it's not set & we know what the entity is
184 if (is_array($values) && !empty($entity)) {
185 foreach ($values as $key => $item) {
186 if (empty($item['id']) && !empty($item[$entity . "_id"])) {
187 $values[$key]['id'] = $item[$entity . "_id"];
189 if(!empty($item['financial_type_id'])){
190 //4.3 legacy handling
191 $values[$key]['contribution_type_id'] = $item['financial_type_id'];
193 if(!empty($item['next_sched_contribution_date'])){
194 // 4.4 legacy handling
195 $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
200 if (is_array($params) && !empty($params['debug'])) {
201 if (is_string($action) && $action != 'getfields') {
202 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) +
$params);
204 elseif ($action != 'getfields') {
205 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
211 $allFields = array();
212 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
213 $allFields = array_keys($apiFields['values']);
215 $paramFields = array_keys($params);
216 $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'));
218 $result['undefined_fields'] = array_merge($undefined);
221 if (is_object($dao)) {
225 $result['version'] = 3;
226 if (is_array($values)) {
227 $result['count'] = (int) count($values);
229 // Convert value-separated strings to array
230 _civicrm_api3_separate_values($values);
232 if ($result['count'] == 1) {
233 list($result['id']) = array_keys($values);
235 elseif (!empty($values['id']) && is_int($values['id'])) {
236 $result['id'] = $values['id'];
240 $result['count'] = !empty($values) ?
1 : 0;
243 if (is_array($values) && isset($params['sequential']) &&
244 $params['sequential'] == 1
246 $result['values'] = array_values($values);
249 $result['values'] = $values;
252 return array_merge($result, $extraReturnValues);
256 * Load the DAO of the entity
258 function _civicrm_api3_load_DAO($entity) {
259 $dao = _civicrm_api3_get_DAO($entity);
268 * Function to return the DAO of the function or Entity
269 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
270 * return the DAO name to manipulate this function
271 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
273 function _civicrm_api3_get_DAO($name) {
274 if (strpos($name, 'civicrm_api3') !== FALSE) {
275 $last = strrpos($name, '_');
276 // len ('civicrm_api3_') == 13
277 $name = substr($name, 13, $last - 13);
280 if (strtolower($name) == 'individual' ||
strtolower($name) == 'household' ||
strtolower($name) == 'organization') {
284 //hack to deal with incorrectly named BAO/DAO - see CRM-10859 -
285 // several of these have been removed but am not confident mailing_recipients is
286 // tests so have not tackled.
287 // correct approach for im is unclear
288 if($name == 'mailing_recipients' ||
$name == 'MailingRecipients'){
289 return 'CRM_Mailing_BAO_Recipients';
291 if(strtolower($name) == 'im'){
292 return 'CRM_Core_BAO_IM';
294 return CRM_Core_DAO_AllCoreTables
::getFullName(_civicrm_api_get_camel_name($name, 3));
298 * Function to return the DAO of the function or Entity
299 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
300 * return the DAO name to manipulate this function
301 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
303 function _civicrm_api3_get_BAO($name) {
304 $dao = _civicrm_api3_get_DAO($name);
305 $dao = str_replace("DAO", "BAO", $dao);
310 * Recursive function to explode value-separated strings into arrays
313 function _civicrm_api3_separate_values(&$values) {
314 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
315 foreach ($values as $key => & $value) {
316 if (is_array($value)) {
317 _civicrm_api3_separate_values($value);
319 elseif (is_string($value)) {
320 if($key == 'case_type_id'){// this is to honor the way case API was originally written
321 $value = trim(str_replace($sp, ',', $value), ',');
323 elseif (strpos($value, $sp) !== FALSE) {
324 $value = explode($sp, trim($value, $sp));
331 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
332 * rather than DAO->fields
334 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
336 * Note this is used by BAO type create functions - eg. contribution
337 * @param string $entity
338 * @param array $params
339 * @param array $values
341 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
342 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
343 $fields = $fields['values'];
344 _civicrm_api3_store_values($fields, $params, $values);
348 * @param array $fields
349 * @param array $params
350 * @param array $values
352 * @return Bool $valueFound
354 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
357 $keys = array_intersect_key($params, $fields);
358 foreach ($keys as $name => $value) {
359 if ($name !== 'id') {
360 $values[$name] = $value;
367 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
368 * This is a generic function for those functions that call it
370 * At the moment only called by contact we should extend to contribution &
371 * others that use the query object. Note that this function passes permission information in.
374 * @param array $params as passed into api get or getcount function
375 * @param array $options array of options (so we can modify the filter)
376 * @param bool $getCount are we just after the count
378 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
380 // Convert id to e.g. contact_id
381 if (empty($params[$entity . '_id']) && isset($params['id'])) {
382 $params[$entity . '_id'] = $params['id'];
384 unset($params['id']);
386 $options = _civicrm_api3_get_options_from_params($params, TRUE);
388 $inputParams = array_merge(
389 CRM_Utils_Array
::value('input_params', $options, array()),
390 CRM_Utils_Array
::value('input_params', $additional_options, array())
392 $returnProperties = array_merge(
393 CRM_Utils_Array
::value('return', $options, array()),
394 CRM_Utils_Array
::value('return', $additional_options, array())
396 if(empty($returnProperties)){
397 $returnProperties = NULL;
399 if(!empty($params['check_permissions'])){
400 // we will filter query object against getfields
401 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
402 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
403 $fields['values'][$entity . '_id'] = array();
404 $varsToFilter = array('returnProperties', 'inputParams');
405 foreach ($varsToFilter as $varToFilter){
406 if(!is_array($
$varToFilter)){
409 //I was going to throw an exception rather than silently filter out - but
410 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
411 //so we are silently ignoring parts of their request
412 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
413 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
416 $options = array_merge($options,$additional_options);
417 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
418 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
419 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
420 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
424 $returnProperties = NULL;
427 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
428 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
429 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
440 if ($getCount) { // only return the count of contacts
448 * Function transfers the filters being passed into the DAO onto the params object
450 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
451 $entity = substr($dao->__table
, 8);
453 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
455 $fields = array_intersect(array_keys($allfields), array_keys($params));
456 if (isset($params[$entity . "_id"])) {
457 //if entity_id is set then treat it as ID (will be overridden by id if set)
458 $dao->id
= $params[$entity . "_id"];
461 $options = _civicrm_api3_get_options_from_params($params);
462 //apply options like sort
463 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
465 //accept filters like filter.activity_date_time_high
466 // std is now 'filters' => ..
467 if (strstr(implode(',', array_keys($params)), 'filter')) {
468 if (isset($params['filters']) && is_array($params['filters'])) {
469 foreach ($params['filters'] as $paramkey => $paramvalue) {
470 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
474 foreach ($params as $paramkey => $paramvalue) {
475 if (strstr($paramkey, 'filter')) {
476 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
481 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
482 // support for other syntaxes is discussed in ticket but being put off for now
483 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
488 foreach ($fields as $field) {
489 if (is_array($params[$field])) {
490 //get the actual fieldname from db
491 $fieldName = $allfields[$field]['name'];
492 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
494 $dao->whereAdd($where);
499 $daoFieldName = $allfields[$field]['name'];
500 if (empty($daoFieldName)) {
501 throw new API_Exception("Failed to determine field name for \"$field\"");
503 $dao->{$daoFieldName} = $params[$field];
506 $dao->$field = $params[$field];
510 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
512 $options['return']['id'] = TRUE;// ensure 'id' is included
513 $allfields = _civicrm_api3_get_unique_name_array($dao);
514 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
515 foreach ($returnMatched as $returnValue) {
516 $dao->selectAdd($returnValue);
519 $unmatchedFields = array_diff(// not already matched on the field names
520 array_keys($options['return']),
524 $returnUniqueMatched = array_intersect(
526 array_flip($allfields)// but a match for the field keys
528 foreach ($returnUniqueMatched as $uniqueVal){
529 $dao->selectAdd($allfields[$uniqueVal]);
535 * Apply filters (e.g. high, low) to DAO object (prior to find)
536 * @param string $filterField field name of filter
537 * @param string $filterValue field value of filter
538 * @param object $dao DAO object
540 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
541 if (strstr($filterField, 'high')) {
542 $fieldName = substr($filterField, 0, -5);
543 $dao->whereAdd("($fieldName <= $filterValue )");
545 if (strstr($filterField, 'low')) {
546 $fieldName = substr($filterField, 0, -4);
547 $dao->whereAdd("($fieldName >= $filterValue )");
549 if($filterField == 'is_current' && $filterValue == 1){
550 $todayStart = date('Ymd000000', strtotime('now'));
551 $todayEnd = date('Ymd235959', strtotime('now'));
552 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
553 if(property_exists($dao, 'is_active')){
554 $dao->whereAdd('is_active = 1');
560 * Get sort, limit etc options from the params - supporting old & new formats.
561 * get returnproperties for legacy
562 * @param array $params params array as passed into civicrm_api
563 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
564 * for legacy report & return a unique fields array
565 * @return array $options options extracted from params
567 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
569 $sort = CRM_Utils_Array
::value('sort', $params, 0);
570 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
571 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
573 $offset = CRM_Utils_Array
::value('offset', $params, 0);
574 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
575 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
576 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
578 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
579 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
580 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
582 if (is_array(CRM_Utils_Array
::value('options', $params))) {
583 // is count is set by generic getcount not user
584 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
585 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
586 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
587 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
590 $returnProperties = array();
591 // handle the format return =sort_name,display_name...
592 if (array_key_exists('return', $params)) {
593 if (is_array($params['return'])) {
594 $returnProperties = array_fill_keys($params['return'], 1);
597 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
598 $returnProperties = array_fill_keys($returnProperties, 1);
601 if($entity && $action =='get' ){
602 if(CRM_Utils_Array
::value('id',$returnProperties)){
603 $returnProperties[$entity . '_id'] = 1;
604 unset($returnProperties['id']);
606 switch (trim(strtolower($sort))){
610 $sort = str_replace('id', $entity . '_id',$sort);
619 'is_count' => $is_count,
620 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
626 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
627 // if the queryobject is being used this should be used
628 $inputParams = array();
629 $legacyreturnProperties = array();
631 'sort', 'offset', 'rowCount', 'options','return',
633 foreach ($params as $n => $v) {
634 if (substr($n, 0, 7) == 'return.') {
635 $legacyreturnProperties[substr($n, 7)] = $v;
638 $inputParams[$entity. '_id'] = $v;
640 elseif (in_array($n, $otherVars)) {}
642 $inputParams[$n] = $v;
645 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
646 $options['input_params'] = $inputParams;
651 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
652 * @param array $params params array as passed into civicrm_api
653 * @param object $dao DAO object
655 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
657 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
658 if(!$options['is_count']) {
659 $dao->limit((int)$options['offset'], (int)$options['limit']);
660 if (!empty($options['sort'])) {
661 $dao->orderBy($options['sort']);
667 * build fields array. This is the array of fields as it relates to the given DAO
668 * returns unique fields as keys by default but if set but can return by DB fields
670 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
671 $fields = $bao->fields();
673 if(!CRM_Utils_Array
::value('id', $fields)){
674 $entity = _civicrm_api_get_entity_name_from_dao($bao);
675 $fields['id'] = $fields[$entity . '_id'];
676 unset($fields[$entity . '_id']);
681 foreach ($fields as $field) {
682 $dbFields[$field['name']] = $field;
688 * build fields array. This is the array of fields as it relates to the given DAO
689 * returns unique fields as keys by default but if set but can return by DB fields
691 function _civicrm_api3_get_unique_name_array(&$bao) {
692 $fields = $bao->fields();
693 foreach ($fields as $field => $values) {
694 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
696 return $uniqueFields;
700 * Converts an DAO object to an array
702 * @param object $dao (reference )object to convert
703 * @params array of arrays (key = id) of array of fields
707 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
709 if(isset($params['options']) && CRM_Utils_Array
::value('is_count', $params['options'])) {
710 return $dao->count();
712 if (empty($dao) ||
!$dao->find()) {
716 if(isset($dao->count
)) {
719 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
720 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
721 foreach ($params['return'] as $return) {
722 if (substr($return, 0, 6) == 'custom') {
729 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
731 while ($dao->fetch()) {
733 foreach ($fields as $key) {
734 if (array_key_exists($key, $dao)) {
735 // not sure on that one
736 if ($dao->$key !== NULL) {
737 $tmp[$key] = $dao->$key;
741 $result[$dao->id
] = $tmp;
742 if (!empty($custom)) {
743 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
752 * Converts an object to an array
754 * @param object $dao (reference) object to convert
755 * @param array $values (reference) array
756 * @param array $uniqueFields
762 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
764 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
765 foreach ($fields as $key => $value) {
766 if (array_key_exists($key, $dao)) {
767 $values[$key] = $dao->$key;
773 * Wrapper for _civicrm_object_to_array when api supports unique fields
775 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
776 return _civicrm_api3_object_to_array($dao, $values, TRUE);
781 * @param array $params
782 * @param array $values
783 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
784 * @param string $entityId ID of entity per $extends
786 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
787 $values['custom'] = array();
788 foreach ($params as $key => $value) {
789 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
790 if ($customFieldID && (!IS_NULL($value))) {
791 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
792 $value, $extends, $customValueID, $entityId, FALSE, FALSE
800 * This function ensures that we have the right input parameters
802 * This function is only called when $dao is passed into verify_mandatory.
803 * The practice of passing $dao into verify_mandatory turned out to be
804 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
805 * api level. Hence the intention is to remove this function
806 * & the associated param from viery_mandatory
808 * @param array $params Associative array of property name/value
809 * pairs to insert in new history.
810 * @daoName string DAO to check params agains
812 * @return bool should the missing fields be returned as an array (core error created as default)
814 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
817 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
818 //@deprecated - see notes
819 if (isset($params['extends'])) {
820 if (($params['extends'] == 'Activity' ||
821 $params['extends'] == 'Phonecall' ||
822 $params['extends'] == 'Meeting' ||
823 $params['extends'] == 'Group' ||
824 $params['extends'] == 'Contribution'
826 ($params['style'] == 'Tab')
828 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
832 $dao = new $daoName();
833 $fields = $dao->fields();
836 foreach ($fields as $k => $v) {
837 if ($v['name'] == 'id') {
841 if (CRM_Utils_Array
::value('required', $v)) {
842 // 0 is a valid input for numbers, CRM-8122
843 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
849 if (!empty($missing)) {
850 if (!empty($return)) {
854 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
862 * Check permissions for a given API call.
864 * @param $entity string API entity being accessed
865 * @param $action string API action being performed
866 * @param $params array params of the API call
867 * @param $throw bool whether to throw exception instead of returning false
869 * @return bool whether the current API user has the permission to make the call
871 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
872 // return early unless we’re told explicitly to do the permission check
873 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
877 require_once 'CRM/Core/DAO/permissions.php';
878 $permissions = _civicrm_api3_permissions($entity, $action, $params);
880 // $params might’ve been reset by the alterAPIPermissions() hook
881 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
885 foreach ($permissions as $perm) {
886 if (!CRM_Core_Permission
::check($perm)) {
888 throw new Exception("API permission check failed for $entity/$action call; missing permission: $perm.");
899 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
901 * @param string $bao_name name of BAO
902 * @param array $params params from api
903 * @param bool $returnAsSuccess return in api success format
905 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
906 $bao = new $bao_name();
907 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
908 if ($returnAsSuccess) {
909 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
912 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
917 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
918 * @param string $bao_name Name of BAO Class
919 * @param array $params parameters passed into the api call
920 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
922 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
924 $args = array(&$params);
925 if (!empty($entity)) {
926 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
930 if (method_exists($bao_name, 'create')) {
932 $fct_name = $bao_name . '::' . $fct;
933 $bao = call_user_func_array(array($bao_name, $fct), $args);
935 elseif (method_exists($bao_name, 'add')) {
937 $fct_name = $bao_name . '::' . $fct;
938 $bao = call_user_func_array(array($bao_name, $fct), $args);
941 $fct_name = '_civicrm_api3_basic_create_fallback';
942 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
946 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
950 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
951 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
956 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
958 * FIXME There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
959 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
961 * @param string $bao_name
962 * @param array $params
963 * @return CRM_Core_DAO|NULL an instance of the BAO
965 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
966 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName(get_parent_class($bao_name));
967 if (empty($entityName)) {
968 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
969 'class_name' => $bao_name,
972 $hook = empty($params['id']) ?
'create' : 'edit';
974 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
975 $instance = new $bao_name();
976 $instance->copyValues($params);
978 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
984 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
985 * if api::del doesn't exist it will try DAO delete method
987 function _civicrm_api3_basic_delete($bao_name, &$params) {
989 civicrm_api3_verify_mandatory($params, NULL, array('id'));
990 $args = array(&$params['id']);
991 if (method_exists($bao_name, 'del')) {
992 $bao = call_user_func_array(array($bao_name, 'del'), $args);
993 if ($bao !== FALSE) {
994 return civicrm_api3_create_success(TRUE);
996 throw new API_Exception('Could not delete entity id ' . $params['id']);
998 elseif (method_exists($bao_name, 'delete')) {
999 $dao = new $bao_name();
1000 $dao->id
= $params['id'];
1002 while ($dao->fetch()) {
1004 return civicrm_api3_create_success();
1008 throw new API_Exception('Could not delete entity id ' . $params['id']);
1012 throw new API_Exception('no delete method found');
1016 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1017 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1019 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1020 * @param string $entity e.g membership, event
1021 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1022 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1023 * @param string $subName - Subtype of entity
1026 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1027 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1028 CRM_Core_DAO
::$_nullObject,
1034 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1035 $customValues = array();
1036 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1037 if (!empty($customValues)) {
1038 foreach ($customValues as $key => $val) {
1039 if (strstr($key, '_id')) {
1040 $idkey = substr($key, 0, -3);
1041 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1042 $returnArray[$key] = $val;
1045 // per standard - return custom_fieldID
1046 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1048 //not standard - but some api did this so guess we should keep - cheap as chips
1049 $returnArray[$key] = $val;
1056 * Validate fields being passed into API. This function relies on the getFields function working accurately
1057 * for the given API. If error mode is set to TRUE then it will also check
1060 * As of writing only date was implemented.
1061 * @param string $entity
1062 * @param string $action
1063 * @param array $params -
1064 * all variables are the same as per civicrm_api
1066 function _civicrm_api3_validate_fields($entity, $action, &$params, $errorMode = NULL) {
1067 //skip any entities without working getfields functions
1068 $skippedEntities = array('entity', 'mailinggroup', 'customvalue', 'custom_value', 'mailing_group');
1069 if (in_array(strtolower($entity), $skippedEntities) ||
strtolower($action) == 'getfields') {
1072 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action));
1073 $fields = array_intersect_key($fields['values'], $params);
1074 foreach ($fields as $fieldName => $fieldInfo) {
1075 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1076 case CRM_Utils_Type
::T_INT
:
1077 //field is of type integer
1078 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1083 //field is of type date or datetime
1084 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1088 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1091 case CRM_Utils_Type
::T_STRING
:
1092 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1095 case CRM_Utils_Type
::T_MONEY
:
1096 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1097 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1101 // intensive checks - usually only called after DB level fail
1102 if (!empty($errorMode) && strtolower($action) == 'create') {
1103 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1104 if (CRM_Utils_Array
::value($fieldName, $params)) {
1105 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1107 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1108 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1111 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1112 $params['entity'] = $entity;
1113 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1120 * Validate date fields being passed into API.
1121 * It currently converts both unique fields and DB field names to a mysql date.
1122 * @todo - probably the unique field handling & the if exists handling is now done before this
1123 * function is reached in the wrapper - can reduce this code down to assume we
1124 * are only checking the passed in field
1126 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1127 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1129 * @param array $params params from civicrm_api
1130 * @param string $fieldName uniquename of field being checked
1131 * @param array $fieldinfo array of fields from getfields function
1133 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1134 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1135 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1136 //accept 'whatever strtotime accepts
1137 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1138 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1140 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1142 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array
::value($fieldName, $params)) {
1143 //If the unique field name differs from the db name & is set handle it here
1144 if (strtotime($params[$fieldName]) === FALSE) {
1145 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1147 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1152 * Validate foreign constraint fields being passed into API.
1154 * @param array $params params from civicrm_api
1155 * @param string $fieldName uniquename of field being checked
1156 * @param array $fieldinfo array of fields from getfields function
1158 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1159 $dao = new $fieldInfo['FKClassName'];
1160 $dao->id
= $params[$fieldName];
1162 $dao->selectAdd('id');
1163 if (!$dao->find()) {
1164 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1169 * Validate foreign constraint fields being passed into API.
1171 * @param array $params params from civicrm_api
1172 * @param string $fieldName uniquename of field being checked
1173 * @param array $fieldinfo array of fields from getfields function
1175 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1176 $existing = civicrm_api($params['entity'], 'get', array(
1177 'version' => $params['version'],
1178 $fieldName => $params[$fieldName],
1180 // an entry already exists for this unique field
1181 if ($existing['count'] == 1) {
1182 // question - could this ever be a security issue?
1183 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1188 * Generic implementation of the "replace" action.
1190 * Replace the old set of entities (matching some given keys) with a new set of
1191 * entities (matching the same keys).
1193 * Note: This will verify that 'values' is present, but it does not directly verify
1194 * any other parameters.
1196 * @param string $entity entity name
1197 * @param array $params params from civicrm_api, including:
1198 * - 'values': an array of records to save
1199 * - all other items: keys which identify new/pre-existing records
1201 function _civicrm_api3_generic_replace($entity, $params) {
1203 $transaction = new CRM_Core_Transaction();
1205 if (!is_array($params['values'])) {
1206 throw new Exception("Mandatory key(s) missing from params array: values");
1209 // Extract the keys -- somewhat scary, don't think too hard about it
1210 $baseParams = $params;
1211 unset($baseParams['values']);
1212 unset($baseParams['sequential']);
1214 // Lookup pre-existing records
1215 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1216 if (civicrm_error($preexisting)) {
1217 $transaction->rollback();
1218 return $preexisting;
1221 // Save the new/updated records
1223 foreach ($params['values'] as $replacement) {
1224 // Sugar: Don't force clients to duplicate the 'key' data
1225 $replacement = array_merge($baseParams, $replacement);
1226 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1227 $create = civicrm_api($entity, $action, $replacement);
1228 if (civicrm_error($create)) {
1229 $transaction->rollback();
1232 foreach ($create['values'] as $entity_id => $entity_value) {
1233 $creates[$entity_id] = $entity_value;
1237 // Remove stale records
1238 $staleIDs = array_diff(
1239 array_keys($preexisting['values']),
1240 array_keys($creates)
1242 foreach ($staleIDs as $staleID) {
1243 $delete = civicrm_api($entity, 'delete', array(
1244 'version' => $params['version'],
1247 if (civicrm_error($delete)) {
1248 $transaction->rollback();
1253 return civicrm_api3_create_success($creates, $params);
1255 catch(PEAR_Exception
$e) {
1256 $transaction->rollback();
1257 return civicrm_api3_create_error($e->getMessage());
1259 catch(Exception
$e) {
1260 $transaction->rollback();
1261 return civicrm_api3_create_error($e->getMessage());
1266 * returns fields allowable by api
1267 * @param $entity string Entity to query
1268 * @param bool $unique index by unique fields?
1270 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1272 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1273 $dao = _civicrm_api3_get_DAO($entity);
1278 $fields = $d->fields();
1279 // replace uniqueNames by the normal names as the key
1280 if (empty($unique)) {
1281 foreach ($fields as $name => & $field) {
1282 //getting rid of unused attributes
1283 foreach ($unsetIfEmpty as $attr) {
1284 if (empty($field[$attr])) {
1285 unset($field[$attr]);
1288 if ($name == $field['name']) {
1291 if (array_key_exists($field['name'], $fields)) {
1292 $field['error'] = 'name conflict';
1293 // it should never happen, but better safe than sorry
1296 $fields[$field['name']] = $field;
1297 $fields[$field['name']]['uniqueName'] = $name;
1298 unset($fields[$name]);
1301 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1306 * Return an array of fields for a given entity - this is the same as the BAO function but
1307 * fields are prefixed with 'custom_' to represent api params
1309 function _civicrm_api_get_custom_fields($entity, &$params) {
1310 $customfields = array();
1311 $entity = _civicrm_api_get_camel_name($entity);
1312 if (strtolower($entity) == 'contact') {
1313 $entity = CRM_Utils_Array
::value('contact_type', $params);
1315 $retrieveOnlyParent = FALSE;
1316 // we could / should probably test for other subtypes here - e.g. activity_type_id
1317 if($entity == 'Contact'){
1318 empty($params['contact_sub_type']);
1320 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1323 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1325 $retrieveOnlyParent,
1329 // find out if we have any requests to resolve options
1330 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1331 if(!is_array($getoptions)){
1332 $getoptions = array($getoptions);
1335 foreach ($customfields as $key => $value) {
1336 // Regular fields have a 'name' property
1337 $value['name'] = 'custom_' . $key;
1338 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1339 $customfields['custom_' . $key] = $value;
1340 if (in_array('custom_' . $key, $getoptions)) {
1341 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1343 unset($customfields[$key]);
1345 return $customfields;
1348 * Translate the custom field data_type attribute into a std 'type'
1350 function _getStandardTypeFromCustomDataType($dataType) {
1352 'String' => CRM_Utils_Type
::T_STRING
,
1353 'Int' => CRM_Utils_Type
::T_INT
,
1354 'Money' => CRM_Utils_Type
::T_MONEY
,
1355 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1356 'Float' => CRM_Utils_Type
::T_FLOAT
,
1357 'Date' => CRM_Utils_Type
::T_DATE
,
1358 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1359 'StateProvince' => CRM_Utils_Type
::T_INT
,
1360 'File' => CRM_Utils_Type
::T_STRING
,
1361 'Link' => CRM_Utils_Type
::T_STRING
,
1362 'ContactReference' => CRM_Utils_Type
::T_INT
,
1363 'Country' => CRM_Utils_Type
::T_INT
,
1365 return $mapping[$dataType];
1368 * Return array of defaults for the given API (function is a wrapper on getfields)
1370 function _civicrm_api3_getdefaults($apiRequest) {
1371 $defaults = array();
1373 $result = civicrm_api3($apiRequest['entity'],
1376 'action' => $apiRequest['action'],
1380 foreach ($result['values'] as $field => $values) {
1381 if (isset($values['api.default'])) {
1382 $defaults[$field] = $values['api.default'];
1389 * Return array of defaults for the given API (function is a wrapper on getfields)
1391 function _civicrm_api3_getrequired($apiRequest) {
1392 $required = array('version');
1394 $result = civicrm_api($apiRequest['entity'],
1398 'action' => $apiRequest['action'],
1401 foreach ($result['values'] as $field => $values) {
1402 if (CRM_Utils_Array
::value('api.required', $values)) {
1403 $required[] = $field;
1410 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1411 * If multiple aliases the last takes precedence
1413 * Function also swaps unique fields for non-unique fields & vice versa.
1415 function _civicrm_api3_swap_out_aliases(&$apiRequest) {
1416 if (strtolower($apiRequest['action'] == 'getfields')) {
1417 if (CRM_Utils_Array
::value('api_action', $apiRequest['params'])) {
1418 $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
1419 unset($apiRequest['params']['api_action']);
1423 $result = civicrm_api3($apiRequest['entity'],
1426 'action' => $apiRequest['action'],
1430 foreach ($result['values'] as $field => $values) {
1431 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1432 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1433 // if aliased field is not set we try to use field alias
1434 if (!isset($apiRequest['params'][$field])) {
1435 foreach ($values['api.aliases'] as $alias) {
1436 if (isset($apiRequest['params'][$alias])) {
1437 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1439 //unset original field nb - need to be careful with this as it may bring inconsistencies
1440 // out of the woodwork but will be implementing only as _spec function extended
1441 unset($apiRequest['params'][$alias]);
1445 if (!isset($apiRequest['params'][$field])
1446 && CRM_Utils_Array
::value('name', $values)
1447 && $field != $values['name']
1448 && isset($apiRequest['params'][$values['name']])
1450 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1451 // note that it would make sense to unset the original field here but tests need to be in place first
1453 if (!isset($apiRequest['params'][$field])
1455 && $field != $uniqueName
1456 && array_key_exists($uniqueName, $apiRequest['params'])
1459 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1460 // note that it would make sense to unset the original field here but tests need to be in place first
1467 * Validate integer fields being passed into API.
1468 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1470 * @param array $params params from civicrm_api
1471 * @param string $fieldName uniquename of field being checked
1472 * @param array $fieldinfo array of fields from getfields function
1474 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1475 //if fieldname exists in params
1476 if (CRM_Utils_Array
::value($fieldName, $params)) {
1477 // if value = 'user_contact_id' (or similar), replace value with contact id
1478 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1479 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1480 if ('unknown-user' === $realContactId) {
1481 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1482 } elseif (is_numeric($realContactId)) {
1483 $params[$fieldName] = $realContactId;
1486 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1487 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1490 // After swapping options, ensure we have an integer(s)
1491 foreach ((array) ($params[$fieldName]) as $value) {
1492 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1493 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1497 // Check our field length
1498 if(is_string($params[$fieldName]) &&
1499 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1500 && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1502 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1503 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1510 * Determine a contact ID using a string expression
1512 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1513 * @return int|NULL|'unknown-user'
1515 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1516 //if value = 'user_contact_id' replace value with logged in user id
1517 if ($contactIdExpr == "user_contact_id") {
1518 $session = &CRM_Core_Session
::singleton();
1519 if (!is_numeric($session->get('userID'))) {
1522 return $session->get('userID');
1523 } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1524 $config = CRM_Core_Config
::singleton();
1526 $ufID = $config->userSystem
->getUfId($matches[1]);
1528 return 'unknown-user';
1531 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1533 return 'unknown-user';
1541 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1542 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1543 if (!CRM_Utils_Rule
::xssString($value)) {
1544 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1550 * Validate string fields being passed into API.
1551 * @param array $params params from civicrm_api
1552 * @param string $fieldName uniquename of field being checked
1553 * @param array $fieldinfo array of fields from getfields function
1555 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1556 // If fieldname exists in params
1557 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1558 if(!is_array($value)){
1559 $value = (string) $value;
1562 //@todo what do we do about passed in arrays. For many of these fields
1563 // the missing piece of functionality is separating them to a separated string
1564 // & many save incorrectly. But can we change them wholesale?
1567 if (!CRM_Utils_Rule
::xssString($value)) {
1568 throw new Exception('Illegal characters in input (potential scripting attack)');
1570 if ($fieldName == 'currency') {
1571 if (!CRM_Utils_Rule
::currencyCode($value)) {
1572 throw new Exception("Currency not a valid code: $value");
1575 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options']) ||
!empty($fieldInfo['enumValues'])) {
1576 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1578 // Check our field length
1579 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1580 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1581 2100, array('field' => $fieldName)
1588 * Validate & swap out any pseudoconstants / options
1590 * @param $params: api parameters
1591 * @param $entity: api entity name
1592 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1593 * @param $fieldInfo: getfields meta-data
1595 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1596 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1598 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1599 $options = CRM_Utils_Array
::value('values', $options, array());
1602 // If passed a value-seperated string, explode to an array, then re-implode after matching values
1604 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1605 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1608 // If passed multiple options, validate each
1609 if (is_array($params[$fieldName])) {
1610 foreach ($params[$fieldName] as &$value) {
1611 if (!is_array($value)) {
1612 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1615 // TODO: unwrap the call to implodePadded from the conditional and do it always
1616 // need to verify that this is safe and doesn't break anything though.
1617 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1619 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1623 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1628 * Validate & swap a single option value for a field
1630 * @param $value: field value
1631 * @param $options: array of options for this field
1632 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1634 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1635 // If option is a key, no need to translate
1636 if (array_key_exists($value, $options)) {
1640 // Translate value into key
1641 $newValue = array_search($value, $options);
1642 if ($newValue !== FALSE) {
1646 // Case-insensitive matching
1647 $newValue = strtolower($value);
1648 $options = array_map("strtolower", $options);
1649 $newValue = array_search($newValue, $options);
1650 if ($newValue === FALSE) {
1651 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1657 * Returns the canonical name of a field
1658 * @param $entity: api entity name (string should already be standardized - no camelCase)
1659 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1661 * @return (string|bool) fieldName or FALSE if the field does not exist
1663 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1664 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1667 if ($fieldName == "{$entity}_id") {
1670 $result = civicrm_api($entity, 'getfields', array(
1672 'action' => 'create',
1674 $meta = $result['values'];
1675 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1676 $fieldName = $fieldName . '_id';
1678 if (isset($meta[$fieldName])) {
1679 return $meta[$fieldName]['name'];
1681 foreach ($meta as $info) {
1682 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1683 return $info['name'];
1685 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1686 return $info['name'];