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 $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 if (!array_key_exists($key, $params) ||
empty($params[$key])) {
124 if (!empty($unmatched)) {
125 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
131 * @param <type> $data
133 * @param object $dao DAO / BAO object to be freed here
135 * @throws API_Exception
136 * @return array <type>
138 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
139 //fix me - $dao should be param 4 & 3 should be $apiRequest
140 if (is_object($dao)) {
144 if (is_array($dao)) {
145 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
147 $fields = _civicrm_api3_api_getfields($dao);
148 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE);
150 catch(Exception
$e) {
151 $msg = $e->getMessage();
155 $data['is_error'] = 1;
156 $data['error_message'] = $msg;
157 // we will show sql to privelledged user only (not sure of a specific
158 // security hole here but seems sensible - perhaps should apply to the trace as well?
159 if(isset($data['sql']) && CRM_Core_Permission
::check('Administer CiviCRM')) {
160 $data['debug_information'] = $data['sql'];
162 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array
::value('api.has_parent', $dao['params'])) {
163 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
164 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
170 * Format array in result output styple
172 * @param array $values values generated by API operation (the result)
173 * @param array $params parameters passed into API call
174 * @param string $entity the entity being acted on
175 * @param string $action the action passed to the API
176 * @param object $dao DAO object to be freed here
177 * @param array $extraReturnValues additional values to be added to top level of result array(
178 * - this param is currently used for legacy behaviour support
180 * @return array $result
182 function civicrm_api3_create_success($values = 1, $params = array(
183 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
185 $result['is_error'] = 0;
186 //lets set the ['id'] field if it's not set & we know what the entity is
187 if (is_array($values) && !empty($entity)) {
188 foreach ($values as $key => $item) {
189 if (empty($item['id']) && !empty($item[$entity . "_id"])) {
190 $values[$key]['id'] = $item[$entity . "_id"];
192 if(!empty($item['financial_type_id'])){
193 //4.3 legacy handling
194 $values[$key]['contribution_type_id'] = $item['financial_type_id'];
196 if(!empty($item['next_sched_contribution_date'])){
197 // 4.4 legacy handling
198 $values[$key]['next_sched_contribution'] = $item['next_sched_contribution_date'];
203 if (is_array($params) && !empty($params['debug'])) {
204 if (is_string($action) && $action != 'getfields') {
205 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) +
$params);
207 elseif ($action != 'getfields') {
208 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
214 $allFields = array();
215 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
216 $allFields = array_keys($apiFields['values']);
218 $paramFields = array_keys($params);
219 $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'));
221 $result['undefined_fields'] = array_merge($undefined);
224 if (is_object($dao)) {
228 $result['version'] = 3;
229 if (is_array($values)) {
230 $result['count'] = (int) count($values);
232 // Convert value-separated strings to array
233 _civicrm_api3_separate_values($values);
235 if ($result['count'] == 1) {
236 list($result['id']) = array_keys($values);
238 elseif (!empty($values['id']) && is_int($values['id'])) {
239 $result['id'] = $values['id'];
243 $result['count'] = !empty($values) ?
1 : 0;
246 if (is_array($values) && isset($params['sequential']) &&
247 $params['sequential'] == 1
249 $result['values'] = array_values($values);
252 $result['values'] = $values;
255 return array_merge($result, $extraReturnValues);
259 * Load the DAO of the entity
261 function _civicrm_api3_load_DAO($entity) {
262 $dao = _civicrm_api3_get_DAO($entity);
271 * Function to return the DAO of the function or Entity
272 * @param String $name either a function of the api (civicrm_{entity}_create or the entity name
273 * return the DAO name to manipulate this function
274 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
275 * @return mixed|string
277 function _civicrm_api3_get_DAO($name) {
278 if (strpos($name, 'civicrm_api3') !== FALSE) {
279 $last = strrpos($name, '_');
280 // len ('civicrm_api3_') == 13
281 $name = substr($name, 13, $last - 13);
284 $name = _civicrm_api_get_camel_name($name, 3);
286 if ($name == 'Individual' ||
$name == 'Household' ||
$name == 'Organization') {
290 // hack to deal with incorrectly named BAO/DAO - see CRM-10859
292 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients
293 // but am not confident mailing_recipients is tested so have not tackled.
294 if ($name == 'MailingRecipients') {
295 return 'CRM_Mailing_DAO_Recipients';
297 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingComponent
298 if ($name == 'MailingComponent') {
299 return 'CRM_Mailing_DAO_Component';
301 // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole
302 if ($name == 'AclRole') {
303 return 'CRM_ACL_DAO_EntityRole';
305 // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
306 // But this would impact SMS extensions so need to coordinate
307 // Probably best approach is to migrate them to use the api and decouple them from core BAOs
308 if ($name == 'SmsProvider') {
309 return 'CRM_SMS_DAO_Provider';
311 // FIXME: DAO names should follow CamelCase convention
312 if ($name == 'Im' ||
$name == 'Acl') {
313 $name = strtoupper($name);
315 return CRM_Core_DAO_AllCoreTables
::getFullName($name);
319 * Function to return the DAO of the function or Entity
320 * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
321 * return the DAO name to manipulate this function
322 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
325 function _civicrm_api3_get_BAO($name) {
326 // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout
327 if ($name == 'PrintLabel') {
328 return 'CRM_Badge_BAO_Layout';
330 $dao = _civicrm_api3_get_DAO($name);
334 $bao = str_replace("DAO", "BAO", $dao);
335 $file = strtr($bao, '_', '/') . '.php';
336 // Check if this entity actually has a BAO. Fall back on the DAO if not.
337 return stream_resolve_include_path($file) ?
$bao : $dao;
341 * Recursive function to explode value-separated strings into arrays
344 function _civicrm_api3_separate_values(&$values) {
345 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
346 foreach ($values as $key => & $value) {
347 if (is_array($value)) {
348 _civicrm_api3_separate_values($value);
350 elseif (is_string($value)) {
351 if($key == 'case_type_id'){// this is to honor the way case API was originally written
352 $value = trim(str_replace($sp, ',', $value), ',');
354 elseif (strpos($value, $sp) !== FALSE) {
355 $value = explode($sp, trim($value, $sp));
362 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
363 * rather than DAO->fields
365 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
367 * Note this is used by BAO type create functions - eg. contribution
368 * @param string $entity
369 * @param array $params
370 * @param array $values
372 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
373 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
374 $fields = $fields['values'];
375 _civicrm_api3_store_values($fields, $params, $values);
379 * @param array $fields
380 * @param array $params
381 * @param array $values
383 * @return Bool $valueFound
385 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
388 $keys = array_intersect_key($params, $fields);
389 foreach ($keys as $name => $value) {
390 if ($name !== 'id') {
391 $values[$name] = $value;
399 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
400 * This is a generic function for those functions that call it
402 * At the moment only called by contact we should extend to contribution &
403 * others that use the query object. Note that this function passes permission information in.
407 * @param array $params as passed into api get or getcount function
408 * @param array $additional_options
409 * @param bool $getCount are we just after the count
412 * @internal param array $options array of options (so we can modify the filter)
414 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
416 // Convert id to e.g. contact_id
417 if (empty($params[$entity . '_id']) && isset($params['id'])) {
418 $params[$entity . '_id'] = $params['id'];
420 unset($params['id']);
422 $options = _civicrm_api3_get_options_from_params($params, TRUE);
424 $inputParams = array_merge(
425 CRM_Utils_Array
::value('input_params', $options, array()),
426 CRM_Utils_Array
::value('input_params', $additional_options, array())
428 $returnProperties = array_merge(
429 CRM_Utils_Array
::value('return', $options, array()),
430 CRM_Utils_Array
::value('return', $additional_options, array())
432 if(empty($returnProperties)){
433 $returnProperties = NULL;
435 if(!empty($params['check_permissions'])){
436 // we will filter query object against getfields
437 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
438 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
439 $fields['values'][$entity . '_id'] = array();
440 $varsToFilter = array('returnProperties', 'inputParams');
441 foreach ($varsToFilter as $varToFilter){
442 if(!is_array($
$varToFilter)){
445 //I was going to throw an exception rather than silently filter out - but
446 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
447 //so we are silently ignoring parts of their request
448 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
449 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
452 $options = array_merge($options,$additional_options);
453 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
454 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
455 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
456 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
460 $returnProperties = NULL;
463 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
464 foreach ($newParams as &$newParam) {
465 if($newParam[1] == '=' && is_array($newParam[2])) {
466 // we may be looking at an attempt to use the 'IN' style syntax
467 // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax
468 $sqlFilter = CRM_Core_DAO
::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
470 $newParam[1] = key($newParam[2]);
471 $newParam[2] = $sqlFilter;
476 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
478 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
489 if ($getCount) { // only return the count of contacts
497 * Function transfers the filters being passed into the DAO onto the params object
499 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
500 $entity = substr($dao->__table
, 8);
502 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
504 $fields = array_intersect(array_keys($allfields), array_keys($params));
505 if (isset($params[$entity . "_id"])) {
506 //if entity_id is set then treat it as ID (will be overridden by id if set)
507 $dao->id
= $params[$entity . "_id"];
510 $options = _civicrm_api3_get_options_from_params($params);
511 //apply options like sort
512 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
514 //accept filters like filter.activity_date_time_high
515 // std is now 'filters' => ..
516 if (strstr(implode(',', array_keys($params)), 'filter')) {
517 if (isset($params['filters']) && is_array($params['filters'])) {
518 foreach ($params['filters'] as $paramkey => $paramvalue) {
519 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
523 foreach ($params as $paramkey => $paramvalue) {
524 if (strstr($paramkey, 'filter')) {
525 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
530 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
531 // support for other syntaxes is discussed in ticket but being put off for now
532 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
537 foreach ($fields as $field) {
538 if (is_array($params[$field])) {
539 //get the actual fieldname from db
540 $fieldName = $allfields[$field]['name'];
541 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
543 $dao->whereAdd($where);
548 $daoFieldName = $allfields[$field]['name'];
549 if (empty($daoFieldName)) {
550 throw new API_Exception("Failed to determine field name for \"$field\"");
552 $dao->{$daoFieldName} = $params[$field];
555 $dao->$field = $params[$field];
559 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
561 $options['return']['id'] = TRUE;// ensure 'id' is included
562 $allfields = _civicrm_api3_get_unique_name_array($dao);
563 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
564 foreach ($returnMatched as $returnValue) {
565 $dao->selectAdd($returnValue);
568 $unmatchedFields = array_diff(// not already matched on the field names
569 array_keys($options['return']),
573 $returnUniqueMatched = array_intersect(
575 array_flip($allfields)// but a match for the field keys
577 foreach ($returnUniqueMatched as $uniqueVal){
578 $dao->selectAdd($allfields[$uniqueVal]);
584 * Apply filters (e.g. high, low) to DAO object (prior to find)
585 * @param string $filterField field name of filter
586 * @param string $filterValue field value of filter
587 * @param object $dao DAO object
589 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
590 if (strstr($filterField, 'high')) {
591 $fieldName = substr($filterField, 0, -5);
592 $dao->whereAdd("($fieldName <= $filterValue )");
594 if (strstr($filterField, 'low')) {
595 $fieldName = substr($filterField, 0, -4);
596 $dao->whereAdd("($fieldName >= $filterValue )");
598 if($filterField == 'is_current' && $filterValue == 1){
599 $todayStart = date('Ymd000000', strtotime('now'));
600 $todayEnd = date('Ymd235959', strtotime('now'));
601 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
602 if(property_exists($dao, 'is_active')){
603 $dao->whereAdd('is_active = 1');
609 * Get sort, limit etc options from the params - supporting old & new formats.
610 * get returnproperties for legacy
612 * @param array $params params array as passed into civicrm_api
613 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
614 * for legacy report & return a unique fields array
616 * @param string $entity
617 * @param string $action
619 * @return array $options options extracted from params
621 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
623 $sort = CRM_Utils_Array
::value('sort', $params, 0);
624 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
625 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
627 $offset = CRM_Utils_Array
::value('offset', $params, 0);
628 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
629 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
630 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
632 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
633 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
634 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
636 if (is_array(CRM_Utils_Array
::value('options', $params))) {
637 // is count is set by generic getcount not user
638 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
639 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
640 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
641 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
644 $returnProperties = array();
645 // handle the format return =sort_name,display_name...
646 if (array_key_exists('return', $params)) {
647 if (is_array($params['return'])) {
648 $returnProperties = array_fill_keys($params['return'], 1);
651 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
652 $returnProperties = array_fill_keys($returnProperties, 1);
655 if ($entity && $action =='get') {
656 if (CRM_Utils_Array
::value('id',$returnProperties)) {
657 $returnProperties[$entity . '_id'] = 1;
658 unset($returnProperties['id']);
660 switch (trim(strtolower($sort))){
664 $sort = str_replace('id', $entity . '_id',$sort);
669 'offset' => CRM_Utils_Rule
::integer($offset) ?
$offset : NULL,
670 'sort' => CRM_Utils_Rule
::string($sort) ?
$sort : NULL,
671 'limit' => CRM_Utils_Rule
::integer($limit) ?
$limit : NULL,
672 'is_count' => $is_count,
673 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
676 if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
677 throw new API_Exception('invalid string in sort options');
683 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
684 // if the queryobject is being used this should be used
685 $inputParams = array();
686 $legacyreturnProperties = array();
688 'sort', 'offset', 'rowCount', 'options','return',
690 foreach ($params as $n => $v) {
691 if (substr($n, 0, 7) == 'return.') {
692 $legacyreturnProperties[substr($n, 7)] = $v;
694 elseif ($n == 'id') {
695 $inputParams[$entity. '_id'] = $v;
697 elseif (in_array($n, $otherVars)) {}
699 $inputParams[$n] = $v;
700 if ($v && !is_array($v) && stristr($v, 'SELECT')) {
701 throw new API_Exception('invalid string');
705 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
706 $options['input_params'] = $inputParams;
711 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
713 * @param array $params params array as passed into civicrm_api
714 * @param object $dao DAO object
717 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
719 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
720 if(!$options['is_count']) {
721 $dao->limit((int)$options['offset'], (int)$options['limit']);
722 if (!empty($options['sort'])) {
723 $dao->orderBy($options['sort']);
729 * build fields array. This is the array of fields as it relates to the given DAO
730 * returns unique fields as keys by default but if set but can return by DB fields
732 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
733 $fields = $bao->fields();
735 if(!CRM_Utils_Array
::value('id', $fields)){
736 $entity = _civicrm_api_get_entity_name_from_dao($bao);
737 $fields['id'] = $fields[$entity . '_id'];
738 unset($fields[$entity . '_id']);
743 foreach ($fields as $field) {
744 $dbFields[$field['name']] = $field;
750 * build fields array. This is the array of fields as it relates to the given DAO
751 * returns unique fields as keys by default but if set but can return by DB fields
753 function _civicrm_api3_get_unique_name_array(&$bao) {
754 $fields = $bao->fields();
755 foreach ($fields as $field => $values) {
756 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
758 return $uniqueFields;
762 * Converts an DAO object to an array
764 * @param object $dao (reference )object to convert
765 * @param null $params
766 * @param bool $uniqueFields
767 * @param string $entity
771 * @params array of arrays (key = id) of array of fields
776 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
778 if(isset($params['options']) && CRM_Utils_Array
::value('is_count', $params['options'])) {
779 return $dao->count();
781 if (empty($dao) ||
!$dao->find()) {
785 if(isset($dao->count
)) {
788 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
789 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
790 foreach ($params['return'] as $return) {
791 if (substr($return, 0, 6) == 'custom') {
798 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
800 while ($dao->fetch()) {
802 foreach ($fields as $key) {
803 if (array_key_exists($key, $dao)) {
804 // not sure on that one
805 if ($dao->$key !== NULL) {
806 $tmp[$key] = $dao->$key;
810 $result[$dao->id
] = $tmp;
811 if (!empty($custom)) {
812 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
821 * Converts an object to an array
823 * @param object $dao (reference) object to convert
824 * @param array $values (reference) array
825 * @param array|bool $uniqueFields
831 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
833 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
834 foreach ($fields as $key => $value) {
835 if (array_key_exists($key, $dao)) {
836 $values[$key] = $dao->$key;
842 * Wrapper for _civicrm_object_to_array when api supports unique fields
844 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
845 return _civicrm_api3_object_to_array($dao, $values, TRUE);
850 * @param array $params
851 * @param array $values
852 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
853 * @param string $entityId ID of entity per $extends
855 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
856 $values['custom'] = array();
857 foreach ($params as $key => $value) {
858 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
859 if ($customFieldID && (!IS_NULL($value))) {
860 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
861 $value, $extends, $customValueID, $entityId, FALSE, FALSE
869 * This function ensures that we have the right input parameters
871 * This function is only called when $dao is passed into verify_mandatory.
872 * The practice of passing $dao into verify_mandatory turned out to be
873 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
874 * api level. Hence the intention is to remove this function
875 * & the associated param from viery_mandatory
877 * @param array $params Associative array of property name/value
878 * pairs to insert in new history.
880 * @param bool $return
882 * @daoName string DAO to check params agains
884 * @return bool should the missing fields be returned as an array (core error created as default)
886 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
889 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
890 //@deprecated - see notes
891 if (isset($params['extends'])) {
892 if (($params['extends'] == 'Activity' ||
893 $params['extends'] == 'Phonecall' ||
894 $params['extends'] == 'Meeting' ||
895 $params['extends'] == 'Group' ||
896 $params['extends'] == 'Contribution'
898 ($params['style'] == 'Tab')
900 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
904 $dao = new $daoName();
905 $fields = $dao->fields();
908 foreach ($fields as $k => $v) {
909 if ($v['name'] == 'id') {
913 if (CRM_Utils_Array
::value('required', $v)) {
914 // 0 is a valid input for numbers, CRM-8122
915 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
921 if (!empty($missing)) {
922 if (!empty($return)) {
926 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
934 * Check permissions for a given API call.
936 * @param $entity string API entity being accessed
937 * @param $action string API action being performed
938 * @param $params array params of the API call
939 * @param $throw deprecated bool whether to throw exception instead of returning false
942 * @return bool whether the current API user has the permission to make the call
944 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
945 // return early unless we’re told explicitly to do the permission check
946 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
950 require_once 'CRM/Core/DAO/permissions.php';
951 $permissions = _civicrm_api3_permissions($entity, $action, $params);
953 // $params might’ve been reset by the alterAPIPermissions() hook
954 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
958 if (!CRM_Core_Permission
::check($permissions)) {
960 if(is_array($permissions)) {
961 $permissions = implode(' and ', $permissions);
963 throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
966 //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
967 // in tests & that should be tidied up
976 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
978 * @param string $bao_name name of BAO
979 * @param array $params params from api
980 * @param bool $returnAsSuccess return in api success format
981 * @param string $entity
985 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
986 $bao = new $bao_name();
987 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
988 if ($returnAsSuccess) {
989 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
992 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
997 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
998 * @param string $bao_name Name of BAO Class
999 * @param array $params parameters passed into the api call
1000 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
1003 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
1005 $args = array(&$params);
1006 if (!empty($entity)) {
1007 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
1011 if (method_exists($bao_name, 'create')) {
1013 $fct_name = $bao_name . '::' . $fct;
1014 $bao = call_user_func_array(array($bao_name, $fct), $args);
1016 elseif (method_exists($bao_name, 'add')) {
1018 $fct_name = $bao_name . '::' . $fct;
1019 $bao = call_user_func_array(array($bao_name, $fct), $args);
1022 $fct_name = '_civicrm_api3_basic_create_fallback';
1023 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1026 if (is_null($bao)) {
1027 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1029 elseif (is_a($bao, 'CRM_Core_Error')) {
1030 //some wierd circular thing means the error takes itself as an argument
1031 $msg = $bao->getMessages($bao);
1032 // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1033 // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1034 // so we need to reset the error object here to avoid getting concatenated errors
1035 //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1036 CRM_Core_Error
::singleton()->reset();
1037 throw new API_Exception($msg);
1041 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
1042 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1047 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1049 * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1050 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1052 * @param string $bao_name
1053 * @param array $params
1055 * @throws API_Exception
1056 * @return CRM_Core_DAO|NULL an instance of the BAO
1058 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1059 $dao_name = get_parent_class($bao_name);
1060 if ($dao_name === 'CRM_Core_DAO' ||
!$dao_name) {
1061 $dao_name = $bao_name;
1063 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($dao_name);
1064 if (empty($entityName)) {
1065 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1066 'class_name' => $bao_name,
1069 $hook = empty($params['id']) ?
'create' : 'edit';
1071 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
1072 $instance = new $dao_name();
1073 $instance->copyValues($params);
1075 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
1081 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1082 * if api::del doesn't exist it will try DAO delete method
1084 function _civicrm_api3_basic_delete($bao_name, &$params) {
1086 civicrm_api3_verify_mandatory($params, NULL, array('id'));
1087 $args = array(&$params['id']);
1088 if (method_exists($bao_name, 'del')) {
1089 $bao = call_user_func_array(array($bao_name, 'del'), $args);
1090 if ($bao !== FALSE) {
1091 return civicrm_api3_create_success(TRUE);
1093 throw new API_Exception('Could not delete entity id ' . $params['id']);
1095 elseif (method_exists($bao_name, 'delete')) {
1096 $dao = new $bao_name();
1097 $dao->id
= $params['id'];
1099 while ($dao->fetch()) {
1101 return civicrm_api3_create_success();
1105 throw new API_Exception('Could not delete entity id ' . $params['id']);
1109 throw new API_Exception('no delete method found');
1113 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1114 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1116 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1117 * @param string $entity e.g membership, event
1119 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1120 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1121 * @param string $subName - Subtype of entity
1123 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1124 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1125 CRM_Core_DAO
::$_nullObject,
1131 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1132 $customValues = array();
1133 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1134 if (!empty($customValues)) {
1135 foreach ($customValues as $key => $val) {
1136 if (strstr($key, '_id')) {
1137 $idkey = substr($key, 0, -3);
1138 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1139 $returnArray[$key] = $val;
1142 // per standard - return custom_fieldID
1143 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1145 //not standard - but some api did this so guess we should keep - cheap as chips
1146 $returnArray[$key] = $val;
1153 * Validate fields being passed into API. This function relies on the getFields function working accurately
1154 * for the given API. If error mode is set to TRUE then it will also check
1157 * As of writing only date was implemented.
1158 * @param string $entity
1159 * @param string $action
1160 * @param array $params -
1161 * @param array $fields response from getfields all variables are the same as per civicrm_api
1162 * @param bool $errorMode errorMode do intensive post fail checks?
1165 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1166 $fields = array_intersect_key($fields, $params);
1167 foreach ($fields as $fieldName => $fieldInfo) {
1168 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1169 case CRM_Utils_Type
::T_INT
:
1170 //field is of type integer
1171 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1176 //field is of type date or datetime
1177 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1181 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1184 case CRM_Utils_Type
::T_STRING
:
1185 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1188 case CRM_Utils_Type
::T_MONEY
:
1189 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1190 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1194 // intensive checks - usually only called after DB level fail
1195 if (!empty($errorMode) && strtolower($action) == 'create') {
1196 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1197 if (CRM_Utils_Array
::value($fieldName, $params)) {
1198 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1200 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1201 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1204 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1205 $params['entity'] = $entity;
1206 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1213 * Validate date fields being passed into API.
1214 * It currently converts both unique fields and DB field names to a mysql date.
1215 * @todo - probably the unique field handling & the if exists handling is now done before this
1216 * function is reached in the wrapper - can reduce this code down to assume we
1217 * are only checking the passed in field
1219 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1220 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1222 * @param array $params params from civicrm_api
1223 * @param string $fieldName uniquename of field being checked
1226 * @internal param array $fieldinfo array of fields from getfields function
1228 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1229 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1230 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1231 //accept 'whatever strtotime accepts
1232 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1233 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1235 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1237 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array
::value($fieldName, $params)) {
1238 //If the unique field name differs from the db name & is set handle it here
1239 if (strtotime($params[$fieldName]) === FALSE) {
1240 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1242 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1247 * Validate foreign constraint fields being passed into API.
1249 * @param array $params params from civicrm_api
1250 * @param string $fieldName uniquename of field being checked
1253 * @internal param array $fieldinfo array of fields from getfields function
1255 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1256 $dao = new $fieldInfo['FKClassName'];
1257 $dao->id
= $params[$fieldName];
1259 $dao->selectAdd('id');
1260 if (!$dao->find()) {
1261 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1266 * Validate foreign constraint fields being passed into API.
1268 * @param array $params params from civicrm_api
1269 * @param string $fieldName uniquename of field being checked
1272 * @internal param array $fieldinfo array of fields from getfields function
1274 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1275 $existing = civicrm_api($params['entity'], 'get', array(
1276 'version' => $params['version'],
1277 $fieldName => $params[$fieldName],
1279 // an entry already exists for this unique field
1280 if ($existing['count'] == 1) {
1281 // question - could this ever be a security issue?
1282 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1287 * Generic implementation of the "replace" action.
1289 * Replace the old set of entities (matching some given keys) with a new set of
1290 * entities (matching the same keys).
1292 * Note: This will verify that 'values' is present, but it does not directly verify
1293 * any other parameters.
1295 * @param string $entity entity name
1296 * @param array $params params from civicrm_api, including:
1297 * - 'values': an array of records to save
1298 * - all other items: keys which identify new/pre-existing records
1301 function _civicrm_api3_generic_replace($entity, $params) {
1303 $transaction = new CRM_Core_Transaction();
1305 if (!is_array($params['values'])) {
1306 throw new Exception("Mandatory key(s) missing from params array: values");
1309 // Extract the keys -- somewhat scary, don't think too hard about it
1310 $baseParams = _civicrm_api3_generic_replace_base_params($params);
1312 // Lookup pre-existing records
1313 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1314 if (civicrm_error($preexisting)) {
1315 $transaction->rollback();
1316 return $preexisting;
1319 // Save the new/updated records
1321 foreach ($params['values'] as $replacement) {
1322 // Sugar: Don't force clients to duplicate the 'key' data
1323 $replacement = array_merge($baseParams, $replacement);
1324 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1325 $create = civicrm_api($entity, $action, $replacement);
1326 if (civicrm_error($create)) {
1327 $transaction->rollback();
1330 foreach ($create['values'] as $entity_id => $entity_value) {
1331 $creates[$entity_id] = $entity_value;
1335 // Remove stale records
1336 $staleIDs = array_diff(
1337 array_keys($preexisting['values']),
1338 array_keys($creates)
1340 foreach ($staleIDs as $staleID) {
1341 $delete = civicrm_api($entity, 'delete', array(
1342 'version' => $params['version'],
1345 if (civicrm_error($delete)) {
1346 $transaction->rollback();
1351 return civicrm_api3_create_success($creates, $params);
1353 catch(PEAR_Exception
$e) {
1354 $transaction->rollback();
1355 return civicrm_api3_create_error($e->getMessage());
1357 catch(Exception
$e) {
1358 $transaction->rollback();
1359 return civicrm_api3_create_error($e->getMessage());
1368 function _civicrm_api3_generic_replace_base_params($params) {
1369 $baseParams = $params;
1370 unset($baseParams['values']);
1371 unset($baseParams['sequential']);
1372 unset($baseParams['options']);
1377 * returns fields allowable by api
1379 * @param $entity string Entity to query
1380 * @param bool $unique index by unique fields?
1381 * @param array $params
1385 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1387 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1388 $dao = _civicrm_api3_get_DAO($entity);
1393 $fields = $d->fields();
1394 // replace uniqueNames by the normal names as the key
1395 if (empty($unique)) {
1396 foreach ($fields as $name => & $field) {
1397 //getting rid of unused attributes
1398 foreach ($unsetIfEmpty as $attr) {
1399 if (empty($field[$attr])) {
1400 unset($field[$attr]);
1403 if ($name == $field['name']) {
1406 if (array_key_exists($field['name'], $fields)) {
1407 $field['error'] = 'name conflict';
1408 // it should never happen, but better safe than sorry
1411 $fields[$field['name']] = $field;
1412 $fields[$field['name']]['uniqueName'] = $name;
1413 unset($fields[$name]);
1416 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1421 * Return an array of fields for a given entity - this is the same as the BAO function but
1422 * fields are prefixed with 'custom_' to represent api params
1424 function _civicrm_api_get_custom_fields($entity, &$params) {
1425 $customfields = array();
1426 $entity = _civicrm_api_get_camel_name($entity);
1427 if (strtolower($entity) == 'contact') {
1428 // Use sub-type if available, otherwise stick with 'Contact'
1429 $entity = CRM_Utils_Array
::value('contact_type', $params);
1431 $retrieveOnlyParent = FALSE;
1432 // we could / should probably test for other subtypes here - e.g. activity_type_id
1433 if($entity == 'Contact'){
1434 empty($params['contact_sub_type']);
1436 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1439 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1441 $retrieveOnlyParent,
1445 // find out if we have any requests to resolve options
1446 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1447 if(!is_array($getoptions)){
1448 $getoptions = array($getoptions);
1451 foreach ($customfields as $key => $value) {
1452 // Regular fields have a 'name' property
1453 $value['name'] = 'custom_' . $key;
1454 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1455 $customfields['custom_' . $key] = $value;
1456 if (in_array('custom_' . $key, $getoptions)) {
1457 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1459 unset($customfields[$key]);
1461 return $customfields;
1464 * Translate the custom field data_type attribute into a std 'type'
1466 function _getStandardTypeFromCustomDataType($dataType) {
1468 'String' => CRM_Utils_Type
::T_STRING
,
1469 'Int' => CRM_Utils_Type
::T_INT
,
1470 'Money' => CRM_Utils_Type
::T_MONEY
,
1471 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1472 'Float' => CRM_Utils_Type
::T_FLOAT
,
1473 'Date' => CRM_Utils_Type
::T_DATE
,
1474 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1475 'StateProvince' => CRM_Utils_Type
::T_INT
,
1476 'File' => CRM_Utils_Type
::T_STRING
,
1477 'Link' => CRM_Utils_Type
::T_STRING
,
1478 'ContactReference' => CRM_Utils_Type
::T_INT
,
1479 'Country' => CRM_Utils_Type
::T_INT
,
1481 return $mapping[$dataType];
1484 * Return array of defaults for the given API (function is a wrapper on getfields)
1486 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1487 $defaults = array();
1489 foreach ($fields as $field => $values) {
1490 if (isset($values['api.default'])) {
1491 $defaults[$field] = $values['api.default'];
1498 * Return array of defaults for the given API (function is a wrapper on getfields)
1500 function _civicrm_api3_getrequired($apiRequest, $fields) {
1501 $required = array('version');
1503 foreach ($fields as $field => $values) {
1504 if (CRM_Utils_Array
::value('api.required', $values)) {
1505 $required[] = $field;
1512 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1513 * If multiple aliases the last takes precedence
1515 * Function also swaps unique fields for non-unique fields & vice versa.
1517 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1518 foreach ($fields as $field => $values) {
1519 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1520 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1521 // if aliased field is not set we try to use field alias
1522 if (!isset($apiRequest['params'][$field])) {
1523 foreach ($values['api.aliases'] as $alias) {
1524 if (isset($apiRequest['params'][$alias])) {
1525 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1527 //unset original field nb - need to be careful with this as it may bring inconsistencies
1528 // out of the woodwork but will be implementing only as _spec function extended
1529 unset($apiRequest['params'][$alias]);
1533 if (!isset($apiRequest['params'][$field])
1534 && CRM_Utils_Array
::value('name', $values)
1535 && $field != $values['name']
1536 && isset($apiRequest['params'][$values['name']])
1538 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1539 // note that it would make sense to unset the original field here but tests need to be in place first
1541 if (!isset($apiRequest['params'][$field])
1543 && $field != $uniqueName
1544 && array_key_exists($uniqueName, $apiRequest['params'])
1547 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1548 // note that it would make sense to unset the original field here but tests need to be in place first
1555 * Validate integer fields being passed into API.
1556 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1558 * @param array $params params from civicrm_api
1559 * @param string $fieldName uniquename of field being checked
1562 * @throws API_Exception
1563 * @internal param array $fieldinfo array of fields from getfields function
1565 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1566 //if fieldname exists in params
1567 if (CRM_Utils_Array
::value($fieldName, $params)) {
1568 // if value = 'user_contact_id' (or similar), replace value with contact id
1569 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1570 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1571 if ('unknown-user' === $realContactId) {
1572 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1573 } elseif (is_numeric($realContactId)) {
1574 $params[$fieldName] = $realContactId;
1577 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1578 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1581 // After swapping options, ensure we have an integer(s)
1582 foreach ((array) ($params[$fieldName]) as $value) {
1583 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1584 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1588 // Check our field length
1589 if(is_string($params[$fieldName]) &&
1590 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1591 && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1593 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1594 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1601 * Determine a contact ID using a string expression
1603 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1604 * @return int|NULL|'unknown-user'
1606 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1607 //if value = 'user_contact_id' replace value with logged in user id
1608 if ($contactIdExpr == "user_contact_id") {
1609 $session = &CRM_Core_Session
::singleton();
1610 if (!is_numeric($session->get('userID'))) {
1613 return $session->get('userID');
1614 } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1615 $config = CRM_Core_Config
::singleton();
1617 $ufID = $config->userSystem
->getUfId($matches[1]);
1619 return 'unknown-user';
1622 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1624 return 'unknown-user';
1633 * Validate html (check for scripting attack)
1638 * @throws API_Exception
1640 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1641 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1642 if (!CRM_Utils_Rule
::xssString($value)) {
1643 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1649 * Validate string fields being passed into API.
1650 * @param array $params params from civicrm_api
1651 * @param string $fieldName uniquename of field being checked
1654 * @throws API_Exception
1656 * @internal param array $fieldinfo array of fields from getfields function
1658 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1659 // If fieldname exists in params
1660 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1661 if(!is_array($value)){
1662 $value = (string) $value;
1665 //@todo what do we do about passed in arrays. For many of these fields
1666 // the missing piece of functionality is separating them to a separated string
1667 // & many save incorrectly. But can we change them wholesale?
1670 if (!CRM_Utils_Rule
::xssString($value)) {
1671 throw new Exception('Illegal characters in input (potential scripting attack)');
1673 if ($fieldName == 'currency') {
1674 if (!CRM_Utils_Rule
::currencyCode($value)) {
1675 throw new Exception("Currency not a valid code: $value");
1678 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options']) ||
!empty($fieldInfo['enumValues'])) {
1679 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1681 // Check our field length
1682 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1683 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1684 2100, array('field' => $fieldName)
1691 * Validate & swap out any pseudoconstants / options
1693 * @param $params: api parameters
1694 * @param $entity: api entity name
1695 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1696 * @param $fieldInfo: getfields meta-data
1698 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1699 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1701 if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1702 // we need to get the options from the entity the field relates to
1703 $entity = $fieldInfo['entity'];
1705 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1706 $options = CRM_Utils_Array
::value('values', $options, array());
1709 // If passed a value-separated string, explode to an array, then re-implode after matching values
1711 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1712 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1715 // If passed multiple options, validate each
1716 if (is_array($params[$fieldName])) {
1717 foreach ($params[$fieldName] as &$value) {
1718 if (!is_array($value)) {
1719 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1722 // TODO: unwrap the call to implodePadded from the conditional and do it always
1723 // need to verify that this is safe and doesn't break anything though.
1724 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1726 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1730 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1735 * Validate & swap a single option value for a field
1737 * @param $value: field value
1738 * @param $options: array of options for this field
1739 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1740 * @throws API_Exception
1742 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1743 // If option is a key, no need to translate
1744 if (array_key_exists($value, $options)) {
1748 // Translate value into key
1749 $newValue = array_search($value, $options);
1750 if ($newValue !== FALSE) {
1754 // Case-insensitive matching
1755 $newValue = strtolower($value);
1756 $options = array_map("strtolower", $options);
1757 $newValue = array_search($newValue, $options);
1758 if ($newValue === FALSE) {
1759 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1765 * Returns the canonical name of a field
1766 * @param $entity: api entity name (string should already be standardized - no camelCase)
1767 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1769 * @return (string|bool) fieldName or FALSE if the field does not exist
1771 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1772 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1775 if ($fieldName == "{$entity}_id") {
1778 $result = civicrm_api($entity, 'getfields', array(
1780 'action' => 'create',
1782 $meta = $result['values'];
1783 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1784 $fieldName = $fieldName . '_id';
1786 if (isset($meta[$fieldName])) {
1787 return $meta[$fieldName]['name'];
1789 foreach ($meta as $info) {
1790 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1791 return $info['name'];
1793 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1794 return $info['name'];