3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * File for CiviCRM APIv3 utilitity functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_utils
34 * @copyright CiviCRM LLC (c) 2004-2013
35 * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $
40 * Initialize CiviCRM - should be run at the start of each API function
42 function _civicrm_api3_initialize() {
43 require_once 'CRM/Core/ClassLoader.php';
44 CRM_Core_ClassLoader
::singleton()->register();
45 CRM_Core_Config
::singleton();
49 * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
51 * @param array $params array of fields to checkl
52 * @param array $daoName string DAO to check for required fields (create functions only)
53 * @param array $keyoptions
55 * @internal param array $keys list of required fields options. One of the options is required
56 * @return null or throws error if there the required fields not present
59 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
61 $keys = array(array());
62 foreach ($keyoptions as $key) {
65 civicrm_api3_verify_mandatory($params, $daoName, $keys);
69 * Function to check mandatory fields are included
71 * @param array $params array of fields to check
72 * @param array $daoName string DAO to check for required fields (create functions only)
73 * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
74 * @param bool $verifyDAO
76 * @throws API_Exception
77 * @return null or throws error if there the required fields not present
79 * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
81 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(), $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 // Disallow empty values except for the number zero.
119 // TODO: create a utility for this since it's needed in many places
120 if (!array_key_exists($key, $params) ||
(empty($params[$key]) && $params[$key] !== 0 && $params[$key] !== '0')) {
125 if (!empty($unmatched)) {
126 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
132 * @param <type> $data
134 * @param object $dao DAO / BAO object to be freed here
136 * @throws API_Exception
137 * @return array <type>
139 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
140 //fix me - $dao should be param 4 & 3 should be $apiRequest
141 if (is_object($dao)) {
145 if (is_array($dao)) {
146 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
148 $fields = _civicrm_api3_api_getfields($dao);
149 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], $fields, TRUE);
151 catch(Exception
$e) {
152 $msg = $e->getMessage();
156 $data['is_error'] = 1;
157 $data['error_message'] = $msg;
158 // we will show sql to privelledged user only (not sure of a specific
159 // security hole here but seems sensible - perhaps should apply to the trace as well?
160 if(isset($data['sql']) && CRM_Core_Permission
::check('Administer CiviCRM')) {
161 $data['debug_information'] = $data['sql'];
163 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && !empty($dao['params']['api.has_parent'])) {
164 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
165 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
171 * Format array in result output styple
173 * @param array $values values generated by API operation (the result)
174 * @param array $params parameters passed into API call
175 * @param string $entity the entity being acted on
176 * @param string $action the action passed to the API
177 * @param object $dao DAO object to be freed here
178 * @param array $extraReturnValues additional values to be added to top level of result array(
179 * - this param is currently used for legacy behaviour support
181 * @return array $result
183 function civicrm_api3_create_success($values = 1, $params = array(), $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;
254 if(!empty($params['options']['metadata'])) {
255 // we've made metadata an array but only supporting 'fields' atm
256 if(in_array('fields', $params['options']['metadata'])) {
257 $fields = civicrm_api3($entity, 'getfields', array('action' => substr($action, 0, 3) == 'get' ?
'get' : 'create'));
258 $result['metadata']['fields'] = $fields['values'];
261 return array_merge($result, $extraReturnValues);
265 * Load the DAO of the entity
267 function _civicrm_api3_load_DAO($entity) {
268 $dao = _civicrm_api3_get_DAO($entity);
277 * Function to return the DAO of the function or Entity
278 * @param String $name either a function of the api (civicrm_{entity}_create or the entity name
279 * return the DAO name to manipulate this function
280 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
281 * @return mixed|string
283 function _civicrm_api3_get_DAO($name) {
284 if (strpos($name, 'civicrm_api3') !== FALSE) {
285 $last = strrpos($name, '_');
286 // len ('civicrm_api3_') == 13
287 $name = substr($name, 13, $last - 13);
290 $name = _civicrm_api_get_camel_name($name, 3);
292 if ($name == 'Individual' ||
$name == 'Household' ||
$name == 'Organization') {
296 // hack to deal with incorrectly named BAO/DAO - see CRM-10859
298 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingRecipients
299 // but am not confident mailing_recipients is tested so have not tackled.
300 if ($name == 'MailingRecipients') {
301 return 'CRM_Mailing_DAO_Recipients';
303 // FIXME: DAO should be renamed CRM_Mailing_DAO_MailingComponent
304 if ($name == 'MailingComponent') {
305 return 'CRM_Mailing_DAO_Component';
307 // FIXME: DAO should be renamed CRM_ACL_DAO_AclRole
308 if ($name == 'AclRole') {
309 return 'CRM_ACL_DAO_EntityRole';
311 // FIXME: DAO should be renamed CRM_SMS_DAO_SmsProvider
312 // But this would impact SMS extensions so need to coordinate
313 // Probably best approach is to migrate them to use the api and decouple them from core BAOs
314 if ($name == 'SmsProvider') {
315 return 'CRM_SMS_DAO_Provider';
317 // FIXME: DAO names should follow CamelCase convention
318 if ($name == 'Im' ||
$name == 'Acl') {
319 $name = strtoupper($name);
321 return CRM_Core_DAO_AllCoreTables
::getFullName($name);
325 * Function to return the DAO of the function or Entity
326 * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
327 * return the DAO name to manipulate this function
328 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
331 function _civicrm_api3_get_BAO($name) {
332 // FIXME: DAO should be renamed CRM_Badge_DAO_BadgeLayout
333 if ($name == 'PrintLabel') {
334 return 'CRM_Badge_BAO_Layout';
336 $dao = _civicrm_api3_get_DAO($name);
340 $bao = str_replace("DAO", "BAO", $dao);
341 $file = strtr($bao, '_', '/') . '.php';
342 // Check if this entity actually has a BAO. Fall back on the DAO if not.
343 return stream_resolve_include_path($file) ?
$bao : $dao;
347 * Recursive function to explode value-separated strings into arrays
350 function _civicrm_api3_separate_values(&$values) {
351 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
352 foreach ($values as $key => & $value) {
353 if (is_array($value)) {
354 _civicrm_api3_separate_values($value);
356 elseif (is_string($value)) {
357 if($key == 'case_type_id'){// this is to honor the way case API was originally written
358 $value = trim(str_replace($sp, ',', $value), ',');
360 elseif (strpos($value, $sp) !== FALSE) {
361 $value = explode($sp, trim($value, $sp));
368 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
369 * rather than DAO->fields
371 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
373 * Note this is used by BAO type create functions - eg. contribution
374 * @param string $entity
375 * @param array $params
376 * @param array $values
378 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
379 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
380 $fields = $fields['values'];
381 _civicrm_api3_store_values($fields, $params, $values);
385 * @param array $fields
386 * @param array $params
387 * @param array $values
389 * @return Bool $valueFound
391 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
394 $keys = array_intersect_key($params, $fields);
395 foreach ($keys as $name => $value) {
396 if ($name !== 'id') {
397 $values[$name] = $value;
405 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
406 * This is a generic function for those functions that call it
408 * At the moment only called by contact we should extend to contribution &
409 * others that use the query object. Note that this function passes permission information in.
413 * @param array $params as passed into api get or getcount function
414 * @param array $additional_options
415 * @param bool $getCount are we just after the count
418 * @internal param array $options array of options (so we can modify the filter)
420 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
422 // Convert id to e.g. contact_id
423 if (empty($params[$entity . '_id']) && isset($params['id'])) {
424 $params[$entity . '_id'] = $params['id'];
426 unset($params['id']);
428 $options = _civicrm_api3_get_options_from_params($params, TRUE);
430 $inputParams = array_merge(
431 CRM_Utils_Array
::value('input_params', $options, array()),
432 CRM_Utils_Array
::value('input_params', $additional_options, array())
434 $returnProperties = array_merge(
435 CRM_Utils_Array
::value('return', $options, array()),
436 CRM_Utils_Array
::value('return', $additional_options, array())
438 if(empty($returnProperties)){
439 $returnProperties = NULL;
441 if(!empty($params['check_permissions'])){
442 // we will filter query object against getfields
443 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
444 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
445 $fields['values'][$entity . '_id'] = array();
446 $varsToFilter = array('returnProperties', 'inputParams');
447 foreach ($varsToFilter as $varToFilter){
448 if(!is_array($
$varToFilter)){
451 //I was going to throw an exception rather than silently filter out - but
452 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
453 //so we are silently ignoring parts of their request
454 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
455 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
458 $options = array_merge($options,$additional_options);
459 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
460 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
461 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
462 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
466 $returnProperties = NULL;
469 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
470 foreach ($newParams as &$newParam) {
471 if($newParam[1] == '=' && is_array($newParam[2])) {
472 // we may be looking at an attempt to use the 'IN' style syntax
473 // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax
474 $sqlFilter = CRM_Core_DAO
::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
476 $newParam[1] = key($newParam[2]);
477 $newParam[2] = $sqlFilter;
482 $skipPermissions = !empty($params['check_permissions']) ?
0 :1;
484 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
495 if ($getCount) { // only return the count of contacts
503 * Function transfers the filters being passed into the DAO onto the params object
505 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
506 $entity = substr($dao->__table
, 8);
508 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
510 $fields = array_intersect(array_keys($allfields), array_keys($params));
511 if (isset($params[$entity . "_id"])) {
512 //if entity_id is set then treat it as ID (will be overridden by id if set)
513 $dao->id
= $params[$entity . "_id"];
516 $options = _civicrm_api3_get_options_from_params($params);
517 //apply options like sort
518 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
520 //accept filters like filter.activity_date_time_high
521 // std is now 'filters' => ..
522 if (strstr(implode(',', array_keys($params)), 'filter')) {
523 if (isset($params['filters']) && is_array($params['filters'])) {
524 foreach ($params['filters'] as $paramkey => $paramvalue) {
525 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
529 foreach ($params as $paramkey => $paramvalue) {
530 if (strstr($paramkey, 'filter')) {
531 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
536 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
537 // support for other syntaxes is discussed in ticket but being put off for now
538 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
543 foreach ($fields as $field) {
544 if (is_array($params[$field])) {
545 //get the actual fieldname from db
546 $fieldName = $allfields[$field]['name'];
547 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
549 $dao->whereAdd($where);
554 $daoFieldName = $allfields[$field]['name'];
555 if (empty($daoFieldName)) {
556 throw new API_Exception("Failed to determine field name for \"$field\"");
558 $dao->{$daoFieldName} = $params[$field];
561 $dao->$field = $params[$field];
565 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
567 $options['return']['id'] = TRUE;// ensure 'id' is included
568 $allfields = _civicrm_api3_get_unique_name_array($dao);
569 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
570 foreach ($returnMatched as $returnValue) {
571 $dao->selectAdd($returnValue);
574 $unmatchedFields = array_diff(// not already matched on the field names
575 array_keys($options['return']),
579 $returnUniqueMatched = array_intersect(
581 array_flip($allfields)// but a match for the field keys
583 foreach ($returnUniqueMatched as $uniqueVal){
584 $dao->selectAdd($allfields[$uniqueVal]);
587 $dao->setApiFilter($params);
591 * Apply filters (e.g. high, low) to DAO object (prior to find)
592 * @param string $filterField field name of filter
593 * @param string $filterValue field value of filter
594 * @param object $dao DAO object
596 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
597 if (strstr($filterField, 'high')) {
598 $fieldName = substr($filterField, 0, -5);
599 $dao->whereAdd("($fieldName <= $filterValue )");
601 if (strstr($filterField, 'low')) {
602 $fieldName = substr($filterField, 0, -4);
603 $dao->whereAdd("($fieldName >= $filterValue )");
605 if($filterField == 'is_current' && $filterValue == 1){
606 $todayStart = date('Ymd000000', strtotime('now'));
607 $todayEnd = date('Ymd235959', strtotime('now'));
608 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
609 if(property_exists($dao, 'is_active')){
610 $dao->whereAdd('is_active = 1');
616 * Get sort, limit etc options from the params - supporting old & new formats.
617 * get returnproperties for legacy
619 * @param array $params params array as passed into civicrm_api
620 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
621 * for legacy report & return a unique fields array
623 * @param string $entity
624 * @param string $action
626 * @return array $options options extracted from params
628 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
630 $sort = CRM_Utils_Array
::value('sort', $params, 0);
631 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
632 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
634 $offset = CRM_Utils_Array
::value('offset', $params, 0);
635 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
636 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
637 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
639 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
640 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
641 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
643 if (is_array(CRM_Utils_Array
::value('options', $params))) {
644 // is count is set by generic getcount not user
645 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
646 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
647 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
648 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
651 $returnProperties = array();
652 // handle the format return =sort_name,display_name...
653 if (array_key_exists('return', $params)) {
654 if (is_array($params['return'])) {
655 $returnProperties = array_fill_keys($params['return'], 1);
658 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
659 $returnProperties = array_fill_keys($returnProperties, 1);
662 if ($entity && $action =='get') {
663 if (!empty($returnProperties['id'])) {
664 $returnProperties[$entity . '_id'] = 1;
665 unset($returnProperties['id']);
667 switch (trim(strtolower($sort))){
671 $sort = str_replace('id', $entity . '_id',$sort);
676 'offset' => CRM_Utils_Rule
::integer($offset) ?
$offset : NULL,
677 'sort' => CRM_Utils_Rule
::string($sort) ?
$sort : NULL,
678 'limit' => CRM_Utils_Rule
::integer($limit) ?
$limit : NULL,
679 'is_count' => $is_count,
680 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
683 if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
684 throw new API_Exception('invalid string in sort options');
690 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
691 // if the queryobject is being used this should be used
692 $inputParams = array();
693 $legacyreturnProperties = array();
695 'sort', 'offset', 'rowCount', 'options','return',
697 foreach ($params as $n => $v) {
698 if (substr($n, 0, 7) == 'return.') {
699 $legacyreturnProperties[substr($n, 7)] = $v;
701 elseif ($n == 'id') {
702 $inputParams[$entity. '_id'] = $v;
704 elseif (in_array($n, $otherVars)) {}
706 $inputParams[$n] = $v;
707 if ($v && !is_array($v) && stristr($v, 'SELECT')) {
708 throw new API_Exception('invalid string');
712 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
713 $options['input_params'] = $inputParams;
718 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
720 * @param array $params params array as passed into civicrm_api
721 * @param object $dao DAO object
724 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
726 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
727 if(!$options['is_count']) {
728 $dao->limit((int)$options['offset'], (int)$options['limit']);
729 if (!empty($options['sort'])) {
730 $dao->orderBy($options['sort']);
736 * build fields array. This is the array of fields as it relates to the given DAO
737 * returns unique fields as keys by default but if set but can return by DB fields
739 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
740 $fields = $bao->fields();
742 if (empty($fields['id'])){
743 $entity = _civicrm_api_get_entity_name_from_dao($bao);
744 $fields['id'] = $fields[$entity . '_id'];
745 unset($fields[$entity . '_id']);
750 foreach ($fields as $field) {
751 $dbFields[$field['name']] = $field;
757 * build fields array. This is the array of fields as it relates to the given DAO
758 * returns unique fields as keys by default but if set but can return by DB fields
760 function _civicrm_api3_get_unique_name_array(&$bao) {
761 $fields = $bao->fields();
762 foreach ($fields as $field => $values) {
763 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
765 return $uniqueFields;
769 * Converts an DAO object to an array
771 * @param object $dao (reference )object to convert
772 * @param null $params
773 * @param bool $uniqueFields
774 * @param string $entity
778 * @params array of arrays (key = id) of array of fields
783 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) {
785 if(isset($params['options']) && !empty($params['options']['is_count'])) {
786 return $dao->count();
791 if ($autoFind && !$dao->find()) {
795 if(isset($dao->count
)) {
798 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
799 if (!empty($entity) && !empty($params['return']) && is_array($params['return'])) {
800 foreach ($params['return'] as $return) {
801 if (substr($return, 0, 6) == 'custom') {
808 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
810 while ($dao->fetch()) {
812 foreach ($fields as $key) {
813 if (array_key_exists($key, $dao)) {
814 // not sure on that one
815 if ($dao->$key !== NULL) {
816 $tmp[$key] = $dao->$key;
820 $result[$dao->id
] = $tmp;
821 if (!empty($custom)) {
822 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
831 * Converts an object to an array
833 * @param object $dao (reference) object to convert
834 * @param array $values (reference) array
835 * @param array|bool $uniqueFields
841 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
843 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
844 foreach ($fields as $key => $value) {
845 if (array_key_exists($key, $dao)) {
846 $values[$key] = $dao->$key;
852 * Wrapper for _civicrm_object_to_array when api supports unique fields
854 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
855 return _civicrm_api3_object_to_array($dao, $values, TRUE);
860 * @param array $params
861 * @param array $values
862 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
863 * @param string $entityId ID of entity per $extends
865 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
866 $values['custom'] = array();
867 foreach ($params as $key => $value) {
868 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
869 if ($customFieldID && (!IS_NULL($value))) {
870 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
871 $value, $extends, $customValueID, $entityId, FALSE, FALSE
879 * This function ensures that we have the right input parameters
881 * This function is only called when $dao is passed into verify_mandatory.
882 * The practice of passing $dao into verify_mandatory turned out to be
883 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
884 * api level. Hence the intention is to remove this function
885 * & the associated param from viery_mandatory
887 * @param array $params Associative array of property name/value
888 * pairs to insert in new history.
890 * @param bool $return
892 * @daoName string DAO to check params agains
894 * @return bool should the missing fields be returned as an array (core error created as default)
896 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
899 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
900 //@deprecated - see notes
901 if (isset($params['extends'])) {
902 if (($params['extends'] == 'Activity' ||
903 $params['extends'] == 'Phonecall' ||
904 $params['extends'] == 'Meeting' ||
905 $params['extends'] == 'Group' ||
906 $params['extends'] == 'Contribution'
908 ($params['style'] == 'Tab')
910 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
914 $dao = new $daoName();
915 $fields = $dao->fields();
918 foreach ($fields as $k => $v) {
919 if ($v['name'] == 'id') {
923 if (!empty($v['required'])) {
924 // 0 is a valid input for numbers, CRM-8122
925 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
931 if (!empty($missing)) {
932 if (!empty($return)) {
936 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
944 * Check permissions for a given API call.
946 * @param $entity string API entity being accessed
947 * @param $action string API action being performed
948 * @param $params array params of the API call
949 * @param $throw deprecated bool whether to throw exception instead of returning false
952 * @return bool whether the current API user has the permission to make the call
954 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
955 // return early unless we’re told explicitly to do the permission check
956 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
960 require_once 'CRM/Core/DAO/permissions.php';
961 $permissions = _civicrm_api3_permissions($entity, $action, $params);
963 // $params might’ve been reset by the alterAPIPermissions() hook
964 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
968 if (!CRM_Core_Permission
::check($permissions)) {
970 if(is_array($permissions)) {
971 $permissions = implode(' and ', $permissions);
973 throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
976 //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
977 // in tests & that should be tidied up
986 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
988 * @param string $bao_name name of BAO
989 * @param array $params params from api
990 * @param bool $returnAsSuccess return in api success format
991 * @param string $entity
995 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
996 $bao = new $bao_name();
997 _civicrm_api3_dao_set_filter($bao, $params, TRUE, $entity);
998 if ($returnAsSuccess) {
999 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity, 'get');
1002 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
1007 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
1008 * @param string $bao_name Name of BAO Class
1009 * @param array $params parameters passed into the api call
1010 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
1013 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
1015 $args = array(&$params);
1016 if (!empty($entity)) {
1017 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
1021 if (method_exists($bao_name, 'create')) {
1023 $fct_name = $bao_name . '::' . $fct;
1024 $bao = call_user_func_array(array($bao_name, $fct), $args);
1026 elseif (method_exists($bao_name, 'add')) {
1028 $fct_name = $bao_name . '::' . $fct;
1029 $bao = call_user_func_array(array($bao_name, $fct), $args);
1032 $fct_name = '_civicrm_api3_basic_create_fallback';
1033 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1036 if (is_null($bao)) {
1037 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1039 elseif (is_a($bao, 'CRM_Core_Error')) {
1040 //some wierd circular thing means the error takes itself as an argument
1041 $msg = $bao->getMessages($bao);
1042 // the api deals with entities on a one-by-one basis. However, the contribution bao pushes entities
1043 // onto the error object - presumably because the contribution import is not handling multiple errors correctly
1044 // so we need to reset the error object here to avoid getting concatenated errors
1045 //@todo - the mulitple error handling should be moved out of the contribution object to the import / multiple entity processes
1046 CRM_Core_Error
::singleton()->reset();
1047 throw new API_Exception($msg);
1051 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
1052 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1057 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1059 * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1060 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1062 * @param string $bao_name
1063 * @param array $params
1065 * @throws API_Exception
1066 * @return CRM_Core_DAO|NULL an instance of the BAO
1068 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1069 $dao_name = get_parent_class($bao_name);
1070 if ($dao_name === 'CRM_Core_DAO' ||
!$dao_name) {
1071 $dao_name = $bao_name;
1073 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName($dao_name);
1074 if (empty($entityName)) {
1075 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1076 'class_name' => $bao_name,
1079 $hook = empty($params['id']) ?
'create' : 'edit';
1081 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
1082 $instance = new $dao_name();
1083 $instance->copyValues($params);
1085 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
1091 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1092 * if api::del doesn't exist it will try DAO delete method
1094 function _civicrm_api3_basic_delete($bao_name, &$params) {
1096 civicrm_api3_verify_mandatory($params, NULL, array('id'));
1097 $args = array(&$params['id']);
1098 if (method_exists($bao_name, 'del')) {
1099 $bao = call_user_func_array(array($bao_name, 'del'), $args);
1100 if ($bao !== FALSE) {
1101 return civicrm_api3_create_success(TRUE);
1103 throw new API_Exception('Could not delete entity id ' . $params['id']);
1105 elseif (method_exists($bao_name, 'delete')) {
1106 $dao = new $bao_name();
1107 $dao->id
= $params['id'];
1109 while ($dao->fetch()) {
1111 return civicrm_api3_create_success();
1115 throw new API_Exception('Could not delete entity id ' . $params['id']);
1119 throw new API_Exception('no delete method found');
1123 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1124 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1126 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1127 * @param string $entity e.g membership, event
1129 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1130 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1131 * @param string $subName - Subtype of entity
1133 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1134 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1135 CRM_Core_DAO
::$_nullObject,
1141 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1142 $customValues = array();
1143 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1144 if (!empty($customValues)) {
1145 foreach ($customValues as $key => $val) {
1146 if (strstr($key, '_id')) {
1147 $idkey = substr($key, 0, -3);
1148 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1149 $returnArray[$key] = $val;
1152 // per standard - return custom_fieldID
1153 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1155 //not standard - but some api did this so guess we should keep - cheap as chips
1156 $returnArray[$key] = $val;
1163 * Validate fields being passed into API. This function relies on the getFields function working accurately
1164 * for the given API. If error mode is set to TRUE then it will also check
1167 * As of writing only date was implemented.
1168 * @param string $entity
1169 * @param string $action
1170 * @param array $params -
1171 * @param array $fields response from getfields all variables are the same as per civicrm_api
1172 * @param bool $errorMode errorMode do intensive post fail checks?
1175 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1176 $fields = array_intersect_key($fields, $params);
1177 foreach ($fields as $fieldName => $fieldInfo) {
1178 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1179 case CRM_Utils_Type
::T_INT
:
1180 //field is of type integer
1181 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1186 //field is of type date or datetime
1187 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1191 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1194 case CRM_Utils_Type
::T_STRING
:
1195 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1198 case CRM_Utils_Type
::T_MONEY
:
1199 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1200 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1204 // intensive checks - usually only called after DB level fail
1205 if (!empty($errorMode) && strtolower($action) == 'create') {
1206 if (!empty($fieldInfo['FKClassName'])) {
1207 if (!empty($params[$fieldName])) {
1208 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1210 elseif (!empty($fieldInfo['required'])) {
1211 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1214 if (!empty($fieldInfo['api.unique'])) {
1215 $params['entity'] = $entity;
1216 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1223 * Validate date fields being passed into API.
1224 * It currently converts both unique fields and DB field names to a mysql date.
1225 * @todo - probably the unique field handling & the if exists handling is now done before this
1226 * function is reached in the wrapper - can reduce this code down to assume we
1227 * are only checking the passed in field
1229 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1230 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1232 * @param array $params params from civicrm_api
1233 * @param string $fieldName uniquename of field being checked
1236 * @internal param array $fieldinfo array of fields from getfields function
1238 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1239 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1240 if (!empty($params[$fieldInfo['name']])) {
1241 //accept 'whatever strtotime accepts
1242 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1243 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1245 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1247 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && !empty($params[$fieldName])) {
1248 //If the unique field name differs from the db name & is set handle it here
1249 if (strtotime($params[$fieldName]) === FALSE) {
1250 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1252 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1257 * Validate foreign constraint fields being passed into API.
1259 * @param array $params params from civicrm_api
1260 * @param string $fieldName uniquename of field being checked
1263 * @internal param array $fieldinfo array of fields from getfields function
1265 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1266 $dao = new $fieldInfo['FKClassName'];
1267 $dao->id
= $params[$fieldName];
1269 $dao->selectAdd('id');
1270 if (!$dao->find()) {
1271 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1276 * Validate foreign constraint fields being passed into API.
1278 * @param array $params params from civicrm_api
1279 * @param string $fieldName uniquename of field being checked
1282 * @internal param array $fieldinfo array of fields from getfields function
1284 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1285 $existing = civicrm_api($params['entity'], 'get', array(
1286 'version' => $params['version'],
1287 $fieldName => $params[$fieldName],
1289 // an entry already exists for this unique field
1290 if ($existing['count'] == 1) {
1291 // question - could this ever be a security issue?
1292 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1297 * Generic implementation of the "replace" action.
1299 * Replace the old set of entities (matching some given keys) with a new set of
1300 * entities (matching the same keys).
1302 * Note: This will verify that 'values' is present, but it does not directly verify
1303 * any other parameters.
1305 * @param string $entity entity name
1306 * @param array $params params from civicrm_api, including:
1307 * - 'values': an array of records to save
1308 * - all other items: keys which identify new/pre-existing records
1311 function _civicrm_api3_generic_replace($entity, $params) {
1313 $transaction = new CRM_Core_Transaction();
1315 if (!is_array($params['values'])) {
1316 throw new Exception("Mandatory key(s) missing from params array: values");
1319 // Extract the keys -- somewhat scary, don't think too hard about it
1320 $baseParams = _civicrm_api3_generic_replace_base_params($params);
1322 // Lookup pre-existing records
1323 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1324 if (civicrm_error($preexisting)) {
1325 $transaction->rollback();
1326 return $preexisting;
1329 // Save the new/updated records
1331 foreach ($params['values'] as $replacement) {
1332 // Sugar: Don't force clients to duplicate the 'key' data
1333 $replacement = array_merge($baseParams, $replacement);
1334 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1335 $create = civicrm_api($entity, $action, $replacement);
1336 if (civicrm_error($create)) {
1337 $transaction->rollback();
1340 foreach ($create['values'] as $entity_id => $entity_value) {
1341 $creates[$entity_id] = $entity_value;
1345 // Remove stale records
1346 $staleIDs = array_diff(
1347 array_keys($preexisting['values']),
1348 array_keys($creates)
1350 foreach ($staleIDs as $staleID) {
1351 $delete = civicrm_api($entity, 'delete', array(
1352 'version' => $params['version'],
1355 if (civicrm_error($delete)) {
1356 $transaction->rollback();
1361 return civicrm_api3_create_success($creates, $params);
1363 catch(PEAR_Exception
$e) {
1364 $transaction->rollback();
1365 return civicrm_api3_create_error($e->getMessage());
1367 catch(Exception
$e) {
1368 $transaction->rollback();
1369 return civicrm_api3_create_error($e->getMessage());
1378 function _civicrm_api3_generic_replace_base_params($params) {
1379 $baseParams = $params;
1380 unset($baseParams['values']);
1381 unset($baseParams['sequential']);
1382 unset($baseParams['options']);
1387 * returns fields allowable by api
1389 * @param $entity string Entity to query
1390 * @param bool $unique index by unique fields?
1391 * @param array $params
1395 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array()) {
1396 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1397 $dao = _civicrm_api3_get_DAO($entity);
1402 $fields = $d->fields();
1403 // replace uniqueNames by the normal names as the key
1404 if (empty($unique)) {
1405 foreach ($fields as $name => & $field) {
1406 //getting rid of unused attributes
1407 foreach ($unsetIfEmpty as $attr) {
1408 if (empty($field[$attr])) {
1409 unset($field[$attr]);
1412 if ($name == $field['name']) {
1415 if (array_key_exists($field['name'], $fields)) {
1416 $field['error'] = 'name conflict';
1417 // it should never happen, but better safe than sorry
1420 $fields[$field['name']] = $field;
1421 $fields[$field['name']]['uniqueName'] = $name;
1422 unset($fields[$name]);
1425 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1430 * Return an array of fields for a given entity - this is the same as the BAO function but
1431 * fields are prefixed with 'custom_' to represent api params
1433 function _civicrm_api_get_custom_fields($entity, &$params) {
1434 $customfields = array();
1435 $entity = _civicrm_api_get_camel_name($entity);
1436 if (strtolower($entity) == 'contact') {
1437 // Use sub-type if available, otherwise stick with 'Contact'
1438 $entity = CRM_Utils_Array
::value('contact_type', $params);
1440 $retrieveOnlyParent = FALSE;
1441 // we could / should probably test for other subtypes here - e.g. activity_type_id
1442 if($entity == 'Contact'){
1443 empty($params['contact_sub_type']);
1445 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1448 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1450 $retrieveOnlyParent,
1454 // find out if we have any requests to resolve options
1455 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1456 if(!is_array($getoptions)){
1457 $getoptions = array($getoptions);
1460 foreach ($customfields as $key => $value) {
1461 // Regular fields have a 'name' property
1462 $value['name'] = 'custom_' . $key;
1463 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1464 $customfields['custom_' . $key] = $value;
1465 if (in_array('custom_' . $key, $getoptions)) {
1466 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1468 unset($customfields[$key]);
1470 return $customfields;
1473 * Translate the custom field data_type attribute into a std 'type'
1475 function _getStandardTypeFromCustomDataType($dataType) {
1477 'String' => CRM_Utils_Type
::T_STRING
,
1478 'Int' => CRM_Utils_Type
::T_INT
,
1479 'Money' => CRM_Utils_Type
::T_MONEY
,
1480 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1481 'Float' => CRM_Utils_Type
::T_FLOAT
,
1482 'Date' => CRM_Utils_Type
::T_DATE
,
1483 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1484 'StateProvince' => CRM_Utils_Type
::T_INT
,
1485 'File' => CRM_Utils_Type
::T_STRING
,
1486 'Link' => CRM_Utils_Type
::T_STRING
,
1487 'ContactReference' => CRM_Utils_Type
::T_INT
,
1488 'Country' => CRM_Utils_Type
::T_INT
,
1490 return $mapping[$dataType];
1493 * Return array of defaults for the given API (function is a wrapper on getfields)
1495 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1496 $defaults = array();
1498 foreach ($fields as $field => $values) {
1499 if (isset($values['api.default'])) {
1500 $defaults[$field] = $values['api.default'];
1507 * Return array of defaults for the given API (function is a wrapper on getfields)
1509 function _civicrm_api3_getrequired($apiRequest, $fields) {
1510 $required = array('version');
1512 foreach ($fields as $field => $values) {
1513 if (!empty($values['api.required'])) {
1514 $required[] = $field;
1521 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1522 * If multiple aliases the last takes precedence
1524 * Function also swaps unique fields for non-unique fields & vice versa.
1526 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1527 foreach ($fields as $field => $values) {
1528 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1529 if (!empty($values['api.aliases'])) {
1530 // if aliased field is not set we try to use field alias
1531 if (!isset($apiRequest['params'][$field])) {
1532 foreach ($values['api.aliases'] as $alias) {
1533 if (isset($apiRequest['params'][$alias])) {
1534 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1536 //unset original field nb - need to be careful with this as it may bring inconsistencies
1537 // out of the woodwork but will be implementing only as _spec function extended
1538 unset($apiRequest['params'][$alias]);
1542 if (!isset($apiRequest['params'][$field]) && !empty($values['name']) && $field != $values['name']
1543 && isset($apiRequest['params'][$values['name']])
1545 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1546 // note that it would make sense to unset the original field here but tests need to be in place first
1548 if (!isset($apiRequest['params'][$field])
1550 && $field != $uniqueName
1551 && array_key_exists($uniqueName, $apiRequest['params'])
1554 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1555 // note that it would make sense to unset the original field here but tests need to be in place first
1562 * Validate integer fields being passed into API.
1563 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1565 * @param array $params params from civicrm_api
1566 * @param string $fieldName uniquename of field being checked
1569 * @throws API_Exception
1570 * @internal param array $fieldinfo array of fields from getfields function
1572 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1573 //if fieldname exists in params
1574 if (!empty($params[$fieldName])) {
1575 // if value = 'user_contact_id' (or similar), replace value with contact id
1576 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1577 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1578 if ('unknown-user' === $realContactId) {
1579 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1580 } elseif (is_numeric($realContactId)) {
1581 $params[$fieldName] = $realContactId;
1584 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1585 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1588 // After swapping options, ensure we have an integer(s)
1589 foreach ((array) ($params[$fieldName]) as $value) {
1590 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1591 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1595 // Check our field length
1596 if(is_string($params[$fieldName]) && !empty($fieldInfo['maxlength']) && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1598 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1599 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1606 * Determine a contact ID using a string expression
1608 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1609 * @return int|NULL|'unknown-user'
1611 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1612 //if value = 'user_contact_id' replace value with logged in user id
1613 if ($contactIdExpr == "user_contact_id") {
1614 $session = &CRM_Core_Session
::singleton();
1615 if (!is_numeric($session->get('userID'))) {
1618 return $session->get('userID');
1619 } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1620 $config = CRM_Core_Config
::singleton();
1622 $ufID = $config->userSystem
->getUfId($matches[1]);
1624 return 'unknown-user';
1627 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1629 return 'unknown-user';
1638 * Validate html (check for scripting attack)
1643 * @throws API_Exception
1645 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1646 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1647 if (!CRM_Utils_Rule
::xssString($value)) {
1648 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1654 * Validate string fields being passed into API.
1655 * @param array $params params from civicrm_api
1656 * @param string $fieldName uniquename of field being checked
1659 * @throws API_Exception
1661 * @internal param array $fieldinfo array of fields from getfields function
1663 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1664 // If fieldname exists in params
1665 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1666 if(!is_array($value)){
1667 $value = (string) $value;
1670 //@todo what do we do about passed in arrays. For many of these fields
1671 // the missing piece of functionality is separating them to a separated string
1672 // & many save incorrectly. But can we change them wholesale?
1675 if (!CRM_Utils_Rule
::xssString($value)) {
1676 throw new Exception('Illegal characters in input (potential scripting attack)');
1678 if ($fieldName == 'currency') {
1679 if (!CRM_Utils_Rule
::currencyCode($value)) {
1680 throw new Exception("Currency not a valid code: $value");
1683 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1684 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1686 // Check our field length
1687 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1688 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1689 2100, array('field' => $fieldName)
1696 * Validate & swap out any pseudoconstants / options
1698 * @param $params: api parameters
1699 * @param $entity: api entity name
1700 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1701 * @param $fieldInfo: getfields meta-data
1703 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1704 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1706 if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1707 // we need to get the options from the entity the field relates to
1708 $entity = $fieldInfo['entity'];
1710 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1711 $options = CRM_Utils_Array
::value('values', $options, array());
1714 // If passed a value-separated string, explode to an array, then re-implode after matching values
1716 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1717 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1720 // If passed multiple options, validate each
1721 if (is_array($params[$fieldName])) {
1722 foreach ($params[$fieldName] as &$value) {
1723 if (!is_array($value)) {
1724 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1727 // TODO: unwrap the call to implodePadded from the conditional and do it always
1728 // need to verify that this is safe and doesn't break anything though.
1729 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1731 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1735 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1740 * Validate & swap a single option value for a field
1742 * @param $value: field value
1743 * @param $options: array of options for this field
1744 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1745 * @throws API_Exception
1747 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1748 // If option is a key, no need to translate
1749 if (array_key_exists($value, $options)) {
1753 // Translate value into key
1754 $newValue = array_search($value, $options);
1755 if ($newValue !== FALSE) {
1759 // Case-insensitive matching
1760 $newValue = strtolower($value);
1761 $options = array_map("strtolower", $options);
1762 $newValue = array_search($newValue, $options);
1763 if ($newValue === FALSE) {
1764 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1770 * Returns the canonical name of a field
1771 * @param $entity: api entity name (string should already be standardized - no camelCase)
1772 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1774 * @return (string|bool) fieldName or FALSE if the field does not exist
1776 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1777 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1780 if ($fieldName == "{$entity}_id") {
1783 $result = civicrm_api($entity, 'getfields', array(
1785 'action' => 'create',
1787 $meta = $result['values'];
1788 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1789 $fieldName = $fieldName . '_id';
1791 if (isset($meta[$fieldName])) {
1792 return $meta[$fieldName]['name'];
1794 foreach ($meta as $info) {
1795 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1796 return $info['name'];
1798 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1799 return $info['name'];