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 if (strtolower($name) == 'individual' ||
strtolower($name) == 'household' ||
strtolower($name) == 'organization') {
288 //hack to deal with incorrectly named BAO/DAO - see CRM-10859 -
289 // several of these have been removed but am not confident mailing_recipients is
290 // tests so have not tackled.
291 // correct approach for im is unclear
292 if($name == 'mailing_recipients' ||
$name == 'MailingRecipients'){
293 return 'CRM_Mailing_BAO_Recipients';
295 if(strtolower($name) == 'im'){
296 return 'CRM_Core_BAO_IM';
298 return CRM_Core_DAO_AllCoreTables
::getFullName(_civicrm_api_get_camel_name($name, 3));
302 * Function to return the DAO of the function or Entity
303 * @param String $name is either a function of the api (civicrm_{entity}_create or the entity name
304 * return the DAO name to manipulate this function
305 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
308 function _civicrm_api3_get_BAO($name) {
309 $dao = _civicrm_api3_get_DAO($name);
313 $bao = str_replace("DAO", "BAO", $dao);
314 $file = strtr($bao, '_', '/') . '.php';
315 // Check if this entity actually has a BAO. Fall back on the DAO if not.
316 return stream_resolve_include_path($file) ?
$bao : $dao;
320 * Recursive function to explode value-separated strings into arrays
323 function _civicrm_api3_separate_values(&$values) {
324 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
325 foreach ($values as $key => & $value) {
326 if (is_array($value)) {
327 _civicrm_api3_separate_values($value);
329 elseif (is_string($value)) {
330 if($key == 'case_type_id'){// this is to honor the way case API was originally written
331 $value = trim(str_replace($sp, ',', $value), ',');
333 elseif (strpos($value, $sp) !== FALSE) {
334 $value = explode($sp, trim($value, $sp));
341 * This is a legacy wrapper for api_store_values which will check the suitable fields using getfields
342 * rather than DAO->fields
344 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
346 * Note this is used by BAO type create functions - eg. contribution
347 * @param string $entity
348 * @param array $params
349 * @param array $values
351 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
352 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
353 $fields = $fields['values'];
354 _civicrm_api3_store_values($fields, $params, $values);
358 * @param array $fields
359 * @param array $params
360 * @param array $values
362 * @return Bool $valueFound
364 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
367 $keys = array_intersect_key($params, $fields);
368 foreach ($keys as $name => $value) {
369 if ($name !== 'id') {
370 $values[$name] = $value;
378 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
379 * This is a generic function for those functions that call it
381 * At the moment only called by contact we should extend to contribution &
382 * others that use the query object. Note that this function passes permission information in.
386 * @param array $params as passed into api get or getcount function
387 * @param array $additional_options
388 * @param bool $getCount are we just after the count
391 * @internal param array $options array of options (so we can modify the filter)
393 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
395 // Convert id to e.g. contact_id
396 if (empty($params[$entity . '_id']) && isset($params['id'])) {
397 $params[$entity . '_id'] = $params['id'];
399 unset($params['id']);
401 $options = _civicrm_api3_get_options_from_params($params, TRUE);
403 $inputParams = array_merge(
404 CRM_Utils_Array
::value('input_params', $options, array()),
405 CRM_Utils_Array
::value('input_params', $additional_options, array())
407 $returnProperties = array_merge(
408 CRM_Utils_Array
::value('return', $options, array()),
409 CRM_Utils_Array
::value('return', $additional_options, array())
411 if(empty($returnProperties)){
412 $returnProperties = NULL;
414 if(!empty($params['check_permissions'])){
415 // we will filter query object against getfields
416 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
417 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
418 $fields['values'][$entity . '_id'] = array();
419 $varsToFilter = array('returnProperties', 'inputParams');
420 foreach ($varsToFilter as $varToFilter){
421 if(!is_array($
$varToFilter)){
424 //I was going to throw an exception rather than silently filter out - but
425 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
426 //so we are silently ignoring parts of their request
427 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
428 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
431 $options = array_merge($options,$additional_options);
432 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
433 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
434 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
435 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
439 $returnProperties = NULL;
442 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
443 foreach ($newParams as &$newParam) {
444 if($newParam[1] == '=' && is_array($newParam[2])) {
445 // we may be looking at an attempt to use the 'IN' style syntax
446 // @todo at time of writing only 'IN' & 'NOT IN' are supported for the array style syntax
447 $sqlFilter = CRM_Core_DAO
::createSqlFilter($newParam[0], $params[$newParam[0]], 'String', NULL, TRUE);
449 $newParam[1] = key($newParam[2]);
450 $newParam[2] = $sqlFilter;
455 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
457 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
468 if ($getCount) { // only return the count of contacts
476 * Function transfers the filters being passed into the DAO onto the params object
478 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
479 $entity = substr($dao->__table
, 8);
481 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
483 $fields = array_intersect(array_keys($allfields), array_keys($params));
484 if (isset($params[$entity . "_id"])) {
485 //if entity_id is set then treat it as ID (will be overridden by id if set)
486 $dao->id
= $params[$entity . "_id"];
489 $options = _civicrm_api3_get_options_from_params($params);
490 //apply options like sort
491 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
493 //accept filters like filter.activity_date_time_high
494 // std is now 'filters' => ..
495 if (strstr(implode(',', array_keys($params)), 'filter')) {
496 if (isset($params['filters']) && is_array($params['filters'])) {
497 foreach ($params['filters'] as $paramkey => $paramvalue) {
498 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
502 foreach ($params as $paramkey => $paramvalue) {
503 if (strstr($paramkey, 'filter')) {
504 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
509 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
510 // support for other syntaxes is discussed in ticket but being put off for now
511 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
516 foreach ($fields as $field) {
517 if (is_array($params[$field])) {
518 //get the actual fieldname from db
519 $fieldName = $allfields[$field]['name'];
520 $where = CRM_Core_DAO
::createSqlFilter($fieldName, $params[$field], 'String');
522 $dao->whereAdd($where);
527 $daoFieldName = $allfields[$field]['name'];
528 if (empty($daoFieldName)) {
529 throw new API_Exception("Failed to determine field name for \"$field\"");
531 $dao->{$daoFieldName} = $params[$field];
534 $dao->$field = $params[$field];
538 if (!empty($options['return']) && is_array($options['return']) && empty($options['is_count'])) {
540 $options['return']['id'] = TRUE;// ensure 'id' is included
541 $allfields = _civicrm_api3_get_unique_name_array($dao);
542 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
543 foreach ($returnMatched as $returnValue) {
544 $dao->selectAdd($returnValue);
547 $unmatchedFields = array_diff(// not already matched on the field names
548 array_keys($options['return']),
552 $returnUniqueMatched = array_intersect(
554 array_flip($allfields)// but a match for the field keys
556 foreach ($returnUniqueMatched as $uniqueVal){
557 $dao->selectAdd($allfields[$uniqueVal]);
563 * Apply filters (e.g. high, low) to DAO object (prior to find)
564 * @param string $filterField field name of filter
565 * @param string $filterValue field value of filter
566 * @param object $dao DAO object
568 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
569 if (strstr($filterField, 'high')) {
570 $fieldName = substr($filterField, 0, -5);
571 $dao->whereAdd("($fieldName <= $filterValue )");
573 if (strstr($filterField, 'low')) {
574 $fieldName = substr($filterField, 0, -4);
575 $dao->whereAdd("($fieldName >= $filterValue )");
577 if($filterField == 'is_current' && $filterValue == 1){
578 $todayStart = date('Ymd000000', strtotime('now'));
579 $todayEnd = date('Ymd235959', strtotime('now'));
580 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
581 if(property_exists($dao, 'is_active')){
582 $dao->whereAdd('is_active = 1');
588 * Get sort, limit etc options from the params - supporting old & new formats.
589 * get returnproperties for legacy
591 * @param array $params params array as passed into civicrm_api
592 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
593 * for legacy report & return a unique fields array
595 * @param string $entity
596 * @param string $action
598 * @return array $options options extracted from params
600 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
602 $sort = CRM_Utils_Array
::value('sort', $params, 0);
603 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
604 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
606 $offset = CRM_Utils_Array
::value('offset', $params, 0);
607 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
608 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
609 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
611 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
612 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
613 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
615 if (is_array(CRM_Utils_Array
::value('options', $params))) {
616 // is count is set by generic getcount not user
617 $is_count = CRM_Utils_Array
::value('is_count', $params['options']);
618 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
619 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
620 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
623 $returnProperties = array();
624 // handle the format return =sort_name,display_name...
625 if (array_key_exists('return', $params)) {
626 if (is_array($params['return'])) {
627 $returnProperties = array_fill_keys($params['return'], 1);
630 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
631 $returnProperties = array_fill_keys($returnProperties, 1);
634 if ($entity && $action =='get') {
635 if (CRM_Utils_Array
::value('id',$returnProperties)) {
636 $returnProperties[$entity . '_id'] = 1;
637 unset($returnProperties['id']);
639 switch (trim(strtolower($sort))){
643 $sort = str_replace('id', $entity . '_id',$sort);
648 'offset' => CRM_Utils_Rule
::integer($offset) ?
$offset : NULL,
649 'sort' => CRM_Utils_Rule
::string($sort) ?
$sort : NULL,
650 'limit' => CRM_Utils_Rule
::integer($limit) ?
$limit : NULL,
651 'is_count' => $is_count,
652 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
655 if ($options['sort'] && stristr($options['sort'], 'SELECT')) {
656 throw new API_Exception('invalid string in sort options');
662 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
663 // if the queryobject is being used this should be used
664 $inputParams = array();
665 $legacyreturnProperties = array();
667 'sort', 'offset', 'rowCount', 'options','return',
669 foreach ($params as $n => $v) {
670 if (substr($n, 0, 7) == 'return.') {
671 $legacyreturnProperties[substr($n, 7)] = $v;
673 elseif ($n == 'id') {
674 $inputParams[$entity. '_id'] = $v;
676 elseif (in_array($n, $otherVars)) {}
678 $inputParams[$n] = $v;
679 if ($v && !is_array($v) && stristr($v, 'SELECT')) {
680 throw new API_Exception('invalid string');
684 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
685 $options['input_params'] = $inputParams;
690 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
692 * @param array $params params array as passed into civicrm_api
693 * @param object $dao DAO object
696 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
698 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
699 if(!$options['is_count']) {
700 $dao->limit((int)$options['offset'], (int)$options['limit']);
701 if (!empty($options['sort'])) {
702 $dao->orderBy($options['sort']);
708 * build fields array. This is the array of fields as it relates to the given DAO
709 * returns unique fields as keys by default but if set but can return by DB fields
711 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
712 $fields = $bao->fields();
714 if(!CRM_Utils_Array
::value('id', $fields)){
715 $entity = _civicrm_api_get_entity_name_from_dao($bao);
716 $fields['id'] = $fields[$entity . '_id'];
717 unset($fields[$entity . '_id']);
722 foreach ($fields as $field) {
723 $dbFields[$field['name']] = $field;
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_get_unique_name_array(&$bao) {
733 $fields = $bao->fields();
734 foreach ($fields as $field => $values) {
735 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
737 return $uniqueFields;
741 * Converts an DAO object to an array
743 * @param object $dao (reference )object to convert
744 * @param null $params
745 * @param bool $uniqueFields
746 * @param string $entity
750 * @params array of arrays (key = id) of array of fields
755 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
757 if(isset($params['options']) && CRM_Utils_Array
::value('is_count', $params['options'])) {
758 return $dao->count();
760 if (empty($dao) ||
!$dao->find()) {
764 if(isset($dao->count
)) {
767 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
768 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
769 foreach ($params['return'] as $return) {
770 if (substr($return, 0, 6) == 'custom') {
777 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
779 while ($dao->fetch()) {
781 foreach ($fields as $key) {
782 if (array_key_exists($key, $dao)) {
783 // not sure on that one
784 if ($dao->$key !== NULL) {
785 $tmp[$key] = $dao->$key;
789 $result[$dao->id
] = $tmp;
790 if (!empty($custom)) {
791 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
800 * Converts an object to an array
802 * @param object $dao (reference) object to convert
803 * @param array $values (reference) array
804 * @param array|bool $uniqueFields
810 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
812 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
813 foreach ($fields as $key => $value) {
814 if (array_key_exists($key, $dao)) {
815 $values[$key] = $dao->$key;
821 * Wrapper for _civicrm_object_to_array when api supports unique fields
823 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
824 return _civicrm_api3_object_to_array($dao, $values, TRUE);
829 * @param array $params
830 * @param array $values
831 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
832 * @param string $entityId ID of entity per $extends
834 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
835 $values['custom'] = array();
836 foreach ($params as $key => $value) {
837 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
838 if ($customFieldID && (!IS_NULL($value))) {
839 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
840 $value, $extends, $customValueID, $entityId, FALSE, FALSE
848 * This function ensures that we have the right input parameters
850 * This function is only called when $dao is passed into verify_mandatory.
851 * The practice of passing $dao into verify_mandatory turned out to be
852 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
853 * api level. Hence the intention is to remove this function
854 * & the associated param from viery_mandatory
856 * @param array $params Associative array of property name/value
857 * pairs to insert in new history.
859 * @param bool $return
861 * @daoName string DAO to check params agains
863 * @return bool should the missing fields be returned as an array (core error created as default)
865 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
868 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
869 //@deprecated - see notes
870 if (isset($params['extends'])) {
871 if (($params['extends'] == 'Activity' ||
872 $params['extends'] == 'Phonecall' ||
873 $params['extends'] == 'Meeting' ||
874 $params['extends'] == 'Group' ||
875 $params['extends'] == 'Contribution'
877 ($params['style'] == 'Tab')
879 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
883 $dao = new $daoName();
884 $fields = $dao->fields();
887 foreach ($fields as $k => $v) {
888 if ($v['name'] == 'id') {
892 if (CRM_Utils_Array
::value('required', $v)) {
893 // 0 is a valid input for numbers, CRM-8122
894 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
900 if (!empty($missing)) {
901 if (!empty($return)) {
905 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
913 * Check permissions for a given API call.
915 * @param $entity string API entity being accessed
916 * @param $action string API action being performed
917 * @param $params array params of the API call
918 * @param $throw deprecated bool whether to throw exception instead of returning false
921 * @return bool whether the current API user has the permission to make the call
923 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
924 // return early unless we’re told explicitly to do the permission check
925 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
929 require_once 'CRM/Core/DAO/permissions.php';
930 $permissions = _civicrm_api3_permissions($entity, $action, $params);
932 // $params might’ve been reset by the alterAPIPermissions() hook
933 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
937 if (!CRM_Core_Permission
::check($permissions)) {
939 if(is_array($permissions)) {
940 $permissions = implode(' and ', $permissions);
942 throw new Exception("API permission check failed for $entity/$action call; insufficient permission: require $permissions");
945 //@todo remove this - this is an internal api function called with $throw set to TRUE. It is only called with false
946 // in tests & that should be tidied up
955 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
957 * @param string $bao_name name of BAO
958 * @param array $params params from api
959 * @param bool $returnAsSuccess return in api success format
960 * @param string $entity
964 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
965 $bao = new $bao_name();
966 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
967 if ($returnAsSuccess) {
968 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
971 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
976 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
977 * @param string $bao_name Name of BAO Class
978 * @param array $params parameters passed into the api call
979 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
982 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
984 $args = array(&$params);
985 if (!empty($entity)) {
986 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
990 if (method_exists($bao_name, 'create')) {
992 $fct_name = $bao_name . '::' . $fct;
993 $bao = call_user_func_array(array($bao_name, $fct), $args);
995 elseif (method_exists($bao_name, 'add')) {
997 $fct_name = $bao_name . '::' . $fct;
998 $bao = call_user_func_array(array($bao_name, $fct), $args);
1001 $fct_name = '_civicrm_api3_basic_create_fallback';
1002 $bao = _civicrm_api3_basic_create_fallback($bao_name, $params);
1005 if (is_null($bao)) {
1006 return civicrm_api3_create_error('Entity not created (' . $fct_name . ')');
1010 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
1011 return civicrm_api3_create_success($values, $params, $entity, 'create', $bao);
1016 * For BAO's which don't have a create() or add() functions, use this fallback implementation.
1018 * @fixme There's an intuitive sense that this behavior should be defined somehow in the BAO/DAO class
1019 * structure. In practice, that requires a fair amount of refactoring and/or kludgery.
1021 * @param string $bao_name
1022 * @param array $params
1024 * @throws API_Exception
1025 * @return CRM_Core_DAO|NULL an instance of the BAO
1027 function _civicrm_api3_basic_create_fallback($bao_name, &$params) {
1028 $entityName = CRM_Core_DAO_AllCoreTables
::getBriefName(get_parent_class($bao_name));
1029 if (empty($entityName)) {
1030 throw new API_Exception("Class \"$bao_name\" does not map to an entity name", "unmapped_class_to_entity", array(
1031 'class_name' => $bao_name,
1034 $hook = empty($params['id']) ?
'create' : 'edit';
1036 CRM_Utils_Hook
::pre($hook, $entityName, CRM_Utils_Array
::value('id', $params), $params);
1037 $instance = new $bao_name();
1038 $instance->copyValues($params);
1040 CRM_Utils_Hook
::post($hook, $entityName, $instance->id
, $instance);
1046 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
1047 * if api::del doesn't exist it will try DAO delete method
1049 function _civicrm_api3_basic_delete($bao_name, &$params) {
1051 civicrm_api3_verify_mandatory($params, NULL, array('id'));
1052 $args = array(&$params['id']);
1053 if (method_exists($bao_name, 'del')) {
1054 $bao = call_user_func_array(array($bao_name, 'del'), $args);
1055 if ($bao !== FALSE) {
1056 return civicrm_api3_create_success(TRUE);
1058 throw new API_Exception('Could not delete entity id ' . $params['id']);
1060 elseif (method_exists($bao_name, 'delete')) {
1061 $dao = new $bao_name();
1062 $dao->id
= $params['id'];
1064 while ($dao->fetch()) {
1066 return civicrm_api3_create_success();
1070 throw new API_Exception('Could not delete entity id ' . $params['id']);
1074 throw new API_Exception('no delete method found');
1078 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1079 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1081 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1082 * @param string $entity e.g membership, event
1084 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1085 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1086 * @param string $subName - Subtype of entity
1088 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1089 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1090 CRM_Core_DAO
::$_nullObject,
1096 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1097 $customValues = array();
1098 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1099 if (!empty($customValues)) {
1100 foreach ($customValues as $key => $val) {
1101 if (strstr($key, '_id')) {
1102 $idkey = substr($key, 0, -3);
1103 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1104 $returnArray[$key] = $val;
1107 // per standard - return custom_fieldID
1108 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1110 //not standard - but some api did this so guess we should keep - cheap as chips
1111 $returnArray[$key] = $val;
1118 * Validate fields being passed into API. This function relies on the getFields function working accurately
1119 * for the given API. If error mode is set to TRUE then it will also check
1122 * As of writing only date was implemented.
1123 * @param string $entity
1124 * @param string $action
1125 * @param array $params -
1126 * @param array $fields response from getfields all variables are the same as per civicrm_api
1127 * @param bool $errorMode errorMode do intensive post fail checks?
1130 function _civicrm_api3_validate_fields($entity, $action, &$params, $fields, $errorMode = False) {
1131 $fields = array_intersect_key($fields, $params);
1132 foreach ($fields as $fieldName => $fieldInfo) {
1133 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1134 case CRM_Utils_Type
::T_INT
:
1135 //field is of type integer
1136 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1141 //field is of type date or datetime
1142 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1146 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1149 case CRM_Utils_Type
::T_STRING
:
1150 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1153 case CRM_Utils_Type
::T_MONEY
:
1154 if (!CRM_Utils_Rule
::money($params[$fieldName]) && !empty($params[$fieldName])) {
1155 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1159 // intensive checks - usually only called after DB level fail
1160 if (!empty($errorMode) && strtolower($action) == 'create') {
1161 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1162 if (CRM_Utils_Array
::value($fieldName, $params)) {
1163 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1165 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1166 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1169 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1170 $params['entity'] = $entity;
1171 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1178 * Validate date fields being passed into API.
1179 * It currently converts both unique fields and DB field names to a mysql date.
1180 * @todo - probably the unique field handling & the if exists handling is now done before this
1181 * function is reached in the wrapper - can reduce this code down to assume we
1182 * are only checking the passed in field
1184 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1185 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1187 * @param array $params params from civicrm_api
1188 * @param string $fieldName uniquename of field being checked
1191 * @internal param array $fieldinfo array of fields from getfields function
1193 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1194 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1195 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1196 //accept 'whatever strtotime accepts
1197 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1198 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1200 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1202 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array
::value($fieldName, $params)) {
1203 //If the unique field name differs from the db name & is set handle it here
1204 if (strtotime($params[$fieldName]) === FALSE) {
1205 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1207 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1212 * Validate foreign constraint fields being passed into API.
1214 * @param array $params params from civicrm_api
1215 * @param string $fieldName uniquename of field being checked
1218 * @internal param array $fieldinfo array of fields from getfields function
1220 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1221 $dao = new $fieldInfo['FKClassName'];
1222 $dao->id
= $params[$fieldName];
1224 $dao->selectAdd('id');
1225 if (!$dao->find()) {
1226 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1231 * Validate foreign constraint fields being passed into API.
1233 * @param array $params params from civicrm_api
1234 * @param string $fieldName uniquename of field being checked
1237 * @internal param array $fieldinfo array of fields from getfields function
1239 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1240 $existing = civicrm_api($params['entity'], 'get', array(
1241 'version' => $params['version'],
1242 $fieldName => $params[$fieldName],
1244 // an entry already exists for this unique field
1245 if ($existing['count'] == 1) {
1246 // question - could this ever be a security issue?
1247 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1252 * Generic implementation of the "replace" action.
1254 * Replace the old set of entities (matching some given keys) with a new set of
1255 * entities (matching the same keys).
1257 * Note: This will verify that 'values' is present, but it does not directly verify
1258 * any other parameters.
1260 * @param string $entity entity name
1261 * @param array $params params from civicrm_api, including:
1262 * - 'values': an array of records to save
1263 * - all other items: keys which identify new/pre-existing records
1266 function _civicrm_api3_generic_replace($entity, $params) {
1268 $transaction = new CRM_Core_Transaction();
1270 if (!is_array($params['values'])) {
1271 throw new Exception("Mandatory key(s) missing from params array: values");
1274 // Extract the keys -- somewhat scary, don't think too hard about it
1275 $baseParams = _civicrm_api3_generic_replace_base_params($params);
1277 // Lookup pre-existing records
1278 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1279 if (civicrm_error($preexisting)) {
1280 $transaction->rollback();
1281 return $preexisting;
1284 // Save the new/updated records
1286 foreach ($params['values'] as $replacement) {
1287 // Sugar: Don't force clients to duplicate the 'key' data
1288 $replacement = array_merge($baseParams, $replacement);
1289 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1290 $create = civicrm_api($entity, $action, $replacement);
1291 if (civicrm_error($create)) {
1292 $transaction->rollback();
1295 foreach ($create['values'] as $entity_id => $entity_value) {
1296 $creates[$entity_id] = $entity_value;
1300 // Remove stale records
1301 $staleIDs = array_diff(
1302 array_keys($preexisting['values']),
1303 array_keys($creates)
1305 foreach ($staleIDs as $staleID) {
1306 $delete = civicrm_api($entity, 'delete', array(
1307 'version' => $params['version'],
1310 if (civicrm_error($delete)) {
1311 $transaction->rollback();
1316 return civicrm_api3_create_success($creates, $params);
1318 catch(PEAR_Exception
$e) {
1319 $transaction->rollback();
1320 return civicrm_api3_create_error($e->getMessage());
1322 catch(Exception
$e) {
1323 $transaction->rollback();
1324 return civicrm_api3_create_error($e->getMessage());
1333 function _civicrm_api3_generic_replace_base_params($params) {
1334 $baseParams = $params;
1335 unset($baseParams['values']);
1336 unset($baseParams['sequential']);
1337 unset($baseParams['options']);
1342 * returns fields allowable by api
1344 * @param $entity string Entity to query
1345 * @param bool $unique index by unique fields?
1346 * @param array $params
1350 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1352 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1353 $dao = _civicrm_api3_get_DAO($entity);
1358 $fields = $d->fields();
1359 // replace uniqueNames by the normal names as the key
1360 if (empty($unique)) {
1361 foreach ($fields as $name => & $field) {
1362 //getting rid of unused attributes
1363 foreach ($unsetIfEmpty as $attr) {
1364 if (empty($field[$attr])) {
1365 unset($field[$attr]);
1368 if ($name == $field['name']) {
1371 if (array_key_exists($field['name'], $fields)) {
1372 $field['error'] = 'name conflict';
1373 // it should never happen, but better safe than sorry
1376 $fields[$field['name']] = $field;
1377 $fields[$field['name']]['uniqueName'] = $name;
1378 unset($fields[$name]);
1381 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1386 * Return an array of fields for a given entity - this is the same as the BAO function but
1387 * fields are prefixed with 'custom_' to represent api params
1389 function _civicrm_api_get_custom_fields($entity, &$params) {
1390 $customfields = array();
1391 $entity = _civicrm_api_get_camel_name($entity);
1392 if (strtolower($entity) == 'contact') {
1393 // Use sub-type if available, otherwise stick with 'Contact'
1394 $entity = CRM_Utils_Array
::value('contact_type', $params);
1396 $retrieveOnlyParent = FALSE;
1397 // we could / should probably test for other subtypes here - e.g. activity_type_id
1398 if($entity == 'Contact'){
1399 empty($params['contact_sub_type']);
1401 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1404 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1406 $retrieveOnlyParent,
1410 // find out if we have any requests to resolve options
1411 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1412 if(!is_array($getoptions)){
1413 $getoptions = array($getoptions);
1416 foreach ($customfields as $key => $value) {
1417 // Regular fields have a 'name' property
1418 $value['name'] = 'custom_' . $key;
1419 $value['type'] = _getStandardTypeFromCustomDataType($value['data_type']);
1420 $customfields['custom_' . $key] = $value;
1421 if (in_array('custom_' . $key, $getoptions)) {
1422 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1424 unset($customfields[$key]);
1426 return $customfields;
1429 * Translate the custom field data_type attribute into a std 'type'
1431 function _getStandardTypeFromCustomDataType($dataType) {
1433 'String' => CRM_Utils_Type
::T_STRING
,
1434 'Int' => CRM_Utils_Type
::T_INT
,
1435 'Money' => CRM_Utils_Type
::T_MONEY
,
1436 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
1437 'Float' => CRM_Utils_Type
::T_FLOAT
,
1438 'Date' => CRM_Utils_Type
::T_DATE
,
1439 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
1440 'StateProvince' => CRM_Utils_Type
::T_INT
,
1441 'File' => CRM_Utils_Type
::T_STRING
,
1442 'Link' => CRM_Utils_Type
::T_STRING
,
1443 'ContactReference' => CRM_Utils_Type
::T_INT
,
1444 'Country' => CRM_Utils_Type
::T_INT
,
1446 return $mapping[$dataType];
1449 * Return array of defaults for the given API (function is a wrapper on getfields)
1451 function _civicrm_api3_getdefaults($apiRequest, $fields) {
1452 $defaults = array();
1454 foreach ($fields as $field => $values) {
1455 if (isset($values['api.default'])) {
1456 $defaults[$field] = $values['api.default'];
1463 * Return array of defaults for the given API (function is a wrapper on getfields)
1465 function _civicrm_api3_getrequired($apiRequest, $fields) {
1466 $required = array('version');
1468 foreach ($fields as $field => $values) {
1469 if (CRM_Utils_Array
::value('api.required', $values)) {
1470 $required[] = $field;
1477 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1478 * If multiple aliases the last takes precedence
1480 * Function also swaps unique fields for non-unique fields & vice versa.
1482 function _civicrm_api3_swap_out_aliases(&$apiRequest, $fields) {
1483 foreach ($fields as $field => $values) {
1484 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1485 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1486 // if aliased field is not set we try to use field alias
1487 if (!isset($apiRequest['params'][$field])) {
1488 foreach ($values['api.aliases'] as $alias) {
1489 if (isset($apiRequest['params'][$alias])) {
1490 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1492 //unset original field nb - need to be careful with this as it may bring inconsistencies
1493 // out of the woodwork but will be implementing only as _spec function extended
1494 unset($apiRequest['params'][$alias]);
1498 if (!isset($apiRequest['params'][$field])
1499 && CRM_Utils_Array
::value('name', $values)
1500 && $field != $values['name']
1501 && isset($apiRequest['params'][$values['name']])
1503 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1504 // note that it would make sense to unset the original field here but tests need to be in place first
1506 if (!isset($apiRequest['params'][$field])
1508 && $field != $uniqueName
1509 && array_key_exists($uniqueName, $apiRequest['params'])
1512 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1513 // note that it would make sense to unset the original field here but tests need to be in place first
1520 * Validate integer fields being passed into API.
1521 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1523 * @param array $params params from civicrm_api
1524 * @param string $fieldName uniquename of field being checked
1527 * @throws API_Exception
1528 * @internal param array $fieldinfo array of fields from getfields function
1530 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1531 //if fieldname exists in params
1532 if (CRM_Utils_Array
::value($fieldName, $params)) {
1533 // if value = 'user_contact_id' (or similar), replace value with contact id
1534 if (!is_numeric($params[$fieldName]) && is_scalar($params[$fieldName])) {
1535 $realContactId = _civicrm_api3_resolve_contactID($params[$fieldName]);
1536 if ('unknown-user' === $realContactId) {
1537 throw new API_Exception("\"$fieldName\" \"{$params[$fieldName]}\" cannot be resolved to a contact ID", 2002, array('error_field' => $fieldName,"type"=>"integer"));
1538 } elseif (is_numeric($realContactId)) {
1539 $params[$fieldName] = $realContactId;
1542 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1543 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1546 // After swapping options, ensure we have an integer(s)
1547 foreach ((array) ($params[$fieldName]) as $value) {
1548 if ($value && !is_numeric($value) && $value !== 'null' && !is_array($value)) {
1549 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1553 // Check our field length
1554 if(is_string($params[$fieldName]) &&
1555 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1556 && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1558 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1559 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1566 * Determine a contact ID using a string expression
1568 * @param string $contactIdExpr e.g. "user_contact_id" or "@user:username"
1569 * @return int|NULL|'unknown-user'
1571 function _civicrm_api3_resolve_contactID($contactIdExpr) {
1572 //if value = 'user_contact_id' replace value with logged in user id
1573 if ($contactIdExpr == "user_contact_id") {
1574 $session = &CRM_Core_Session
::singleton();
1575 if (!is_numeric($session->get('userID'))) {
1578 return $session->get('userID');
1579 } elseif (preg_match('/^@user:(.*)$/', $contactIdExpr, $matches)) {
1580 $config = CRM_Core_Config
::singleton();
1582 $ufID = $config->userSystem
->getUfId($matches[1]);
1584 return 'unknown-user';
1587 $contactID = CRM_Core_BAO_UFMatch
::getContactId($ufID);
1589 return 'unknown-user';
1598 * Validate html (check for scripting attack)
1603 * @throws API_Exception
1605 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1606 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1607 if (!CRM_Utils_Rule
::xssString($value)) {
1608 throw new API_Exception('Illegal characters in input (potential scripting attack)', array("field"=>$fieldName,"error_code"=>"xss"));
1614 * Validate string fields being passed into API.
1615 * @param array $params params from civicrm_api
1616 * @param string $fieldName uniquename of field being checked
1619 * @throws API_Exception
1621 * @internal param array $fieldinfo array of fields from getfields function
1623 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1624 // If fieldname exists in params
1625 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1626 if(!is_array($value)){
1627 $value = (string) $value;
1630 //@todo what do we do about passed in arrays. For many of these fields
1631 // the missing piece of functionality is separating them to a separated string
1632 // & many save incorrectly. But can we change them wholesale?
1635 if (!CRM_Utils_Rule
::xssString($value)) {
1636 throw new Exception('Illegal characters in input (potential scripting attack)');
1638 if ($fieldName == 'currency') {
1639 if (!CRM_Utils_Rule
::currencyCode($value)) {
1640 throw new Exception("Currency not a valid code: $value");
1643 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options']) ||
!empty($fieldInfo['enumValues'])) {
1644 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1646 // Check our field length
1647 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1648 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1649 2100, array('field' => $fieldName)
1656 * Validate & swap out any pseudoconstants / options
1658 * @param $params: api parameters
1659 * @param $entity: api entity name
1660 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1661 * @param $fieldInfo: getfields meta-data
1663 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1664 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1666 if(strtolower($entity) == 'profile' && !empty($fieldInfo['entity'])) {
1667 // we need to get the options from the entity the field relates to
1668 $entity = $fieldInfo['entity'];
1670 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name'], 'context' => 'validate'));
1671 $options = CRM_Utils_Array
::value('values', $options, array());
1674 // If passed a value-separated string, explode to an array, then re-implode after matching values
1676 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1677 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1680 // If passed multiple options, validate each
1681 if (is_array($params[$fieldName])) {
1682 foreach ($params[$fieldName] as &$value) {
1683 if (!is_array($value)) {
1684 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1687 // TODO: unwrap the call to implodePadded from the conditional and do it always
1688 // need to verify that this is safe and doesn't break anything though.
1689 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1691 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1695 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1700 * Validate & swap a single option value for a field
1702 * @param $value: field value
1703 * @param $options: array of options for this field
1704 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1705 * @throws API_Exception
1707 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1708 // If option is a key, no need to translate
1709 if (array_key_exists($value, $options)) {
1713 // Translate value into key
1714 $newValue = array_search($value, $options);
1715 if ($newValue !== FALSE) {
1719 // Case-insensitive matching
1720 $newValue = strtolower($value);
1721 $options = array_map("strtolower", $options);
1722 $newValue = array_search($newValue, $options);
1723 if ($newValue === FALSE) {
1724 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1730 * Returns the canonical name of a field
1731 * @param $entity: api entity name (string should already be standardized - no camelCase)
1732 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1734 * @return (string|bool) fieldName or FALSE if the field does not exist
1736 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1737 if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) {
1740 if ($fieldName == "{$entity}_id") {
1743 $result = civicrm_api($entity, 'getfields', array(
1745 'action' => 'create',
1747 $meta = $result['values'];
1748 if (!isset($meta[$fieldName]['name']) && isset($meta[$fieldName . '_id'])) {
1749 $fieldName = $fieldName . '_id';
1751 if (isset($meta[$fieldName])) {
1752 return $meta[$fieldName]['name'];
1754 foreach ($meta as $info) {
1755 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1756 return $info['name'];
1758 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1759 return $info['name'];