5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for CiviCRM APIv3 utilitity functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_utils
36 * @copyright CiviCRM LLC (c) 2004-2013
37 * @version $Id: utils.php 30879 2010-11-22 15:45:55Z shot $
42 * Initialize CiviCRM - should be run at the start of each API function
44 function _civicrm_api3_initialize() {
45 require_once 'CRM/Core/ClassLoader.php';
46 CRM_Core_ClassLoader
::singleton()->register();
47 CRM_Core_Config
::singleton();
51 * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
53 * @param array $params array of fields to check
54 * @param array $daoName string DAO to check for required fields (create functions only)
55 * @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
61 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
63 $keys = array(array());
64 foreach ($keyoptions as $key) {
67 civicrm_api3_verify_mandatory($params, $daoName, $keys);
71 * Function to check mandatory fields are included
73 * @param array $params array of fields to check
74 * @param array $daoName string DAO to check for required fields (create functions only)
75 * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
76 * @param bool $verifyDAO
78 * @return null or throws error if there the required fields not present
80 * @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
82 function civicrm_api3_verify_mandatory($params, $daoName = NULL, $keys = array(
83 ), $verifyDAO = TRUE) {
86 if ($daoName != NULL && $verifyDAO && empty($params['id'])) {
87 $unmatched = _civicrm_api3_check_required_fields($params, $daoName, TRUE);
88 if (!is_array($unmatched)) {
93 if (!empty($params['id'])) {
94 $keys = array('version');
97 if (!in_array('version', $keys)) {
98 // required from v3 onwards
102 foreach ($keys as $key) {
103 if (is_array($key)) {
105 $optionset = array();
106 foreach ($key as $subkey) {
107 if (!array_key_exists($subkey, $params) ||
empty($params[$subkey])) {
108 $optionset[] = $subkey;
111 // as long as there is one match then we don't need to rtn anything
115 if (empty($match) && !empty($optionset)) {
116 $unmatched[] = "one of (" . implode(", ", $optionset) . ")";
120 if (!array_key_exists($key, $params) ||
empty($params[$key])) {
125 if (!empty($unmatched)) {
126 throw new API_Exception("Mandatory key(s) missing from params array: " . implode(", ", $unmatched),"mandatory_missing",array("fields"=>$unmatched));
133 * @param <type> $data
134 * @param object $dao DAO / BAO object to be freed here
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 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], TRUE);
149 catch(Exception
$e) {
150 $msg = $e->getMessage();
154 $data['is_error'] = 1;
155 $data['error_message'] = $msg;
156 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array
::value('api.has_parent', $dao['params'])) {
157 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
158 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
164 * Format array in result output styple
166 * @param array $values values generated by API operation (the result)
167 * @param array $params parameters passed into API call
168 * @param string $entity the entity being acted on
169 * @param string $action the action passed to the API
170 * @param object $dao DAO object to be freed here
171 * @param array $extraReturnValues additional values to be added to top level of result array(
172 * - this param is currently used for legacy behaviour support
174 * @return array $result
176 function civicrm_api3_create_success($values = 1, $params = array(
177 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
179 $result['is_error'] = 0;
180 //lets set the ['id'] field if it's not set & we know what the entity is
181 if (is_array($values) && !empty($entity)) {
182 foreach ($values as $key => $item) {
183 if (empty($item['id']) && !empty($item[$entity . "_id"])) {
184 $values[$key]['id'] = $item[$entity . "_id"];
186 if(!empty($item['financial_type_id'])){
187 $values[$key]['contribution_type_id'] = $item['financial_type_id'];
191 //if ( array_key_exists ('debug',$params) && is_object ($dao)) {
192 if (is_array($params) && array_key_exists('debug', $params)) {
193 if (is_string($action) && $action != 'getfields') {
194 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) +
$params);
196 elseif ($action != 'getfields') {
197 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
203 $allFields = array();
204 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
205 $allFields = array_keys($apiFields['values']);
207 $paramFields = array_keys($params);
208 $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'));
210 $result['undefined_fields'] = array_merge($undefined);
213 if (is_object($dao)) {
217 $result['version'] = 3;
218 if (is_array($values)) {
219 $result['count'] = count($values);
221 // Convert value-separated strings to array
222 _civicrm_api3_separate_values($values);
224 if ($result['count'] == 1) {
225 list($result['id']) = array_keys($values);
227 elseif (!empty($values['id']) && is_int($values['id'])) {
228 $result['id'] = $values['id'];
232 $result['count'] = !empty($values) ?
1 : 0;
235 if (is_array($values) && isset($params['sequential']) &&
236 $params['sequential'] == 1
238 $result['values'] = array_values($values);
241 $result['values'] = $values;
244 return array_merge($result, $extraReturnValues);
248 * Load the DAO of the entity
250 function _civicrm_api3_load_DAO($entity) {
251 $dao = _civicrm_api3_get_DAO($entity);
260 * Function to return the DAO of the function or Entity
261 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
262 * return the DAO name to manipulate this function
263 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
265 function _civicrm_api3_get_DAO($name) {
266 if (strpos($name, 'civicrm_api3') !== FALSE) {
267 $last = strrpos($name, '_');
268 // len ('civicrm_api3_') == 13
269 $name = substr($name, 13, $last - 13);
272 if (strtolower($name) == 'individual' ||
strtolower($name) == 'household' ||
strtolower($name) == 'organization') {
276 //hack to deal with incorrectly named BAO/DAO - see CRM-10859 - remove after rename
277 if($name == 'price_set' ||
$name == 'PriceSet'){
278 return 'CRM_Price_DAO_Set';
280 if($name == 'price_field' ||
$name == 'PriceField'){
281 return 'CRM_Price_DAO_Field';
283 if($name == 'price_field_value' ||
$name == 'PriceFieldValue'){
284 return 'CRM_Price_DAO_FieldValue';
286 // these aren't listed on ticket CRM-10859 - but same problem - lack of standardisation
287 if($name == 'mailing_job' ||
$name == 'MailingJob'){
288 return 'CRM_Mailing_BAO_Job';
290 if($name == 'mailing_recipients' ||
$name == 'MailingRecipients'){
291 return 'CRM_Mailing_BAO_Recipients';
293 if(strtolower($name) == 'im'){
294 return 'CRM_Core_BAO_IM';
296 return CRM_Core_DAO_AllCoreTables
::getFullName(_civicrm_api_get_camel_name($name, 3));
300 * Function to return the DAO of the function or Entity
301 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
302 * return the DAO name to manipulate this function
303 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
305 function _civicrm_api3_get_BAO($name) {
306 $dao = _civicrm_api3_get_DAO($name);
307 $dao = str_replace("DAO", "BAO", $dao);
312 * Recursive function to explode value-separated strings into arrays
315 function _civicrm_api3_separate_values(&$values) {
316 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
317 foreach ($values as $key => & $value) {
318 if (is_array($value)) {
319 _civicrm_api3_separate_values($value);
321 elseif (is_string($value)) {
322 if($key == 'case_type_id'){// this is to honor the way case API was originally written
323 $value = trim(str_replace($sp, ',', $value), ',');
325 elseif (strpos($value, $sp) !== FALSE) {
326 $value = explode($sp, trim($value, $sp));
333 * This is a wrapper for api_store_values which will check the suitable fields using getfields
334 * rather than DAO->fields
336 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
338 * Note this is used by BAO type create functions - eg. contribution
339 * @param string $entity
340 * @param array $params
341 * @param array $values
343 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
344 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
345 $fields = $fields['values'];
346 _civicrm_api3_store_values($fields, $params, $values);
350 * @param array $fields
351 * @param array $params
352 * @param array $values
354 * @return Bool $valueFound
356 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
359 $keys = array_intersect_key($params, $fields);
360 foreach ($keys as $name => $value) {
361 if ($name !== 'id') {
362 $values[$name] = $value;
369 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
370 * This is a generic function for those functions that call it
372 * At the moment only called by contact we should extend to contribution &
373 * others that use the query object. Note that this function passes permission information in.
376 * @param array $params as passed into api get or getcount function
377 * @param array $options array of options (so we can modify the filter)
378 * @param bool $getCount are we just after the count
380 function _civicrm_api3_get_using_query_object($entity, $params, $additional_options = array(), $getCount = NULL){
382 // Convert id to e.g. contact_id
383 if (empty($params[$entity . '_id']) && isset($params['id'])) {
384 $params[$entity . '_id'] = $params['id'];
386 unset($params['id']);
388 $options = _civicrm_api3_get_options_from_params($params, TRUE);
390 $inputParams = array_merge(
391 CRM_Utils_Array
::value('input_params', $options, array()),
392 CRM_Utils_Array
::value('input_params', $additional_options, array())
394 $returnProperties = array_merge(
395 CRM_Utils_Array
::value('return', $options, array()),
396 CRM_Utils_Array
::value('return', $additional_options, array())
398 if(empty($returnProperties)){
399 $returnProperties = NULL;
401 if(!empty($params['check_permissions'])){
402 // we will filter query object against getfields
403 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => 'get'));
404 // we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
405 $fields['values'][$entity . '_id'] = array();
406 $varsToFilter = array('returnProperties', 'inputParams');
407 foreach ($varsToFilter as $varToFilter){
408 if(!is_array($
$varToFilter)){
411 //I was going to throw an exception rather than silently filter out - but
412 //would need to diff out of exceptions arr other keys like 'options', 'return', 'api. etcetc
413 //so we are silently ignoring parts of their request
414 //$exceptionsArr = array_diff(array_keys($$varToFilter), array_keys($fields['values']));
415 $
$varToFilter = array_intersect_key($
$varToFilter, $fields['values']);
418 $options = array_merge($options,$additional_options);
419 $sort = CRM_Utils_Array
::value('sort', $options, NULL);
420 $offset = CRM_Utils_Array
::value('offset', $options, NULL);
421 $limit = CRM_Utils_Array
::value('limit', $options, NULL);
422 $smartGroupCache = CRM_Utils_Array
::value('smartGroupCache', $params);
426 $returnProperties = NULL;
429 $newParams = CRM_Contact_BAO_Query
::convertFormValues($inputParams);
430 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
431 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
442 if ($getCount) { // only return the count of contacts
450 * Function transfers the filters being passed into the DAO onto the params object
452 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
453 $entity = substr($dao->__table
, 8);
455 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
457 $fields = array_intersect(array_keys($allfields), array_keys($params));
458 if (isset($params[$entity . "_id"])) {
459 //if entity_id is set then treat it as ID (will be overridden by id if set)
460 $dao->id
= $params[$entity . "_id"];
463 $options = _civicrm_api3_get_options_from_params($params);
464 //apply options like sort
465 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
467 //accept filters like filter.activity_date_time_high
468 // std is now 'filters' => ..
469 if (strstr(implode(',', array_keys($params)), 'filter')) {
470 if (isset($params['filters']) && is_array($params['filters'])) {
471 foreach ($params['filters'] as $paramkey => $paramvalue) {
472 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
476 foreach ($params as $paramkey => $paramvalue) {
477 if (strstr($paramkey, 'filter')) {
478 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
483 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
484 // support for other syntaxes is discussed in ticket but being put off for now
485 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
490 foreach ($fields as $field) {
491 if (is_array($params[$field])) {
492 //get the actual fieldname from db
493 $fieldName = $allfields[$field]['name'];
494 //array is the syntax for SQL clause
495 foreach ($params[$field] as $operator => $criteria) {
496 if (in_array($operator, $acceptedSQLOperators)) {
502 $dao->whereAdd(sprintf('%s %s', $fieldName, $operator));
509 if (empty($criteria[0]) ||
empty($criteria[1])) {
510 throw new exception("invalid criteria for $operator");
512 $dao->whereAdd(sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
519 if (empty($criteria)) {
520 throw new exception("invalid criteria for $operator");
522 $escapedCriteria = array_map(array('CRM_Core_DAO', 'escapeString'), $criteria);
523 $dao->whereAdd(sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
530 $dao->whereAdd(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
537 $daoFieldName = $allfields[$field]['name'];
538 if (empty($daoFieldName)) {
539 throw new API_Exception("Failed to determine field name for \"$field\"");
541 $dao->{$daoFieldName} = $params[$field];
544 $dao->$field = $params[$field];
548 if (!empty($options['return']) && is_array($options['return'])) {
550 $options['return']['id'] = TRUE;// ensure 'id' is included
551 $allfields = _civicrm_api3_get_unique_name_array($dao);
552 $returnMatched = array_intersect(array_keys($options['return']), $allfields);
553 $returnUniqueMatched = array_intersect(
554 array_diff(// not already matched on the field names
557 array_flip($allfields)// but a match for the field keys
560 foreach ($returnMatched as $returnValue) {
561 $dao->selectAdd($returnValue);
563 foreach ($returnUniqueMatched as $uniqueVal){
564 $dao->selectAdd($allfields[$uniqueVal]);
571 * Apply filters (e.g. high, low) to DAO object (prior to find)
572 * @param string $filterField field name of filter
573 * @param string $filterValue field value of filter
574 * @param object $dao DAO object
576 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
577 if (strstr($filterField, 'high')) {
578 $fieldName = substr($filterField, 0, -5);
579 $dao->whereAdd("($fieldName <= $filterValue )");
581 if (strstr($filterField, 'low')) {
582 $fieldName = substr($filterField, 0, -4);
583 $dao->whereAdd("($fieldName >= $filterValue )");
585 if($filterField == 'is_current' && $filterValue == 1){
586 $todayStart = date('Ymd000000', strtotime('now'));
587 $todayEnd = date('Ymd235959', strtotime('now'));
588 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
589 if(property_exists($dao, 'is_active')){
590 $dao->whereAdd('is_active = 1');
596 * Get sort, limit etc options from the params - supporting old & new formats.
597 * get returnproperties for legacy
598 * @param array $params params array as passed into civicrm_api
599 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
600 * for legacy report & return a unique fields array
601 * @return array $options options extracted from params
603 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
604 $sort = CRM_Utils_Array
::value('sort', $params, 0);
605 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
606 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
608 $offset = CRM_Utils_Array
::value('offset', $params, 0);
609 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
610 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
611 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
613 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
614 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
615 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
617 if (is_array(CRM_Utils_Array
::value('options', $params))) {
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);
652 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
657 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
658 // if the queryobject is being used this should be used
659 $inputParams = array();
660 $legacyreturnProperties = array();
662 'sort', 'offset', 'rowCount', 'options','return',
664 foreach ($params as $n => $v) {
665 if (substr($n, 0, 7) == 'return.') {
666 $legacyreturnProperties[substr($n, 7)] = $v;
669 $inputParams[$entity. '_id'] = $v;
671 elseif (in_array($n, $otherVars)) {}
673 $inputParams[$n] = $v;
676 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
677 $options['input_params'] = $inputParams;
682 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
683 * @param array $params params array as passed into civicrm_api
684 * @param object $dao DAO object
686 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
688 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
689 $dao->limit((int)$options['offset'], (int)$options['limit']);
690 if (!empty($options['sort'])) {
691 $dao->orderBy($options['sort']);
696 * build fields array. This is the array of fields as it relates to the given DAO
697 * returns unique fields as keys by default but if set but can return by DB fields
699 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
700 $fields = $bao->fields();
702 if(!CRM_Utils_Array
::value('id', $fields)){
703 $entity = _civicrm_api_get_entity_name_from_dao($bao);
704 $fields['id'] = $fields[$entity . '_id'];
705 unset($fields[$entity . '_id']);
710 foreach ($fields as $field) {
711 $dbFields[$field['name']] = $field;
717 * build fields array. This is the array of fields as it relates to the given DAO
718 * returns unique fields as keys by default but if set but can return by DB fields
720 function _civicrm_api3_get_unique_name_array(&$bao) {
721 $fields = $bao->fields();
722 foreach ($fields as $field => $values) {
723 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
725 return $uniqueFields;
729 * Converts an DAO object to an array
731 * @param object $dao (reference )object to convert
732 * @params array of arrays (key = id) of array of fields
736 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
738 if (empty($dao) ||
!$dao->find()) {
742 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
743 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
744 foreach ($params['return'] as $return) {
745 if (substr($return, 0, 6) == 'custom') {
752 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
754 while ($dao->fetch()) {
756 foreach ($fields as $key) {
757 if (array_key_exists($key, $dao)) {
758 // not sure on that one
759 if ($dao->$key !== NULL) {
760 $tmp[$key] = $dao->$key;
764 $result[$dao->id
] = $tmp;
765 if (!empty($custom)) {
766 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
775 * Converts an object to an array
777 * @param object $dao (reference) object to convert
778 * @param array $values (reference) array
779 * @param array $uniqueFields
785 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
787 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
788 foreach ($fields as $key => $value) {
789 if (array_key_exists($key, $dao)) {
790 $values[$key] = $dao->$key;
796 * Wrapper for _civicrm_object_to_array when api supports unique fields
798 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
799 return _civicrm_api3_object_to_array($dao, $values, TRUE);
804 * @param array $params
805 * @param array $values
806 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
807 * @param string $entityId ID of entity per $extends
809 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
810 $values['custom'] = array();
811 foreach ($params as $key => $value) {
812 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
813 if ($customFieldID && (!IS_NULL($value))) {
814 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
815 $value, $extends, $customValueID, $entityId, FALSE, FALSE
823 * This function ensures that we have the right input parameters
825 * This function is only called when $dao is passed into verify_mandatory.
826 * The practice of passing $dao into verify_mandatory turned out to be
827 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
828 * api level. Hence the intention is to remove this function
829 * & the associated param from viery_mandatory
831 * @param array $params Associative array of property name/value
832 * pairs to insert in new history.
833 * @daoName string DAO to check params agains
835 * @return bool should the missing fields be returned as an array (core error created as default)
837 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
840 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
841 //@deprecated - see notes
842 if (isset($params['extends'])) {
843 if (($params['extends'] == 'Activity' ||
844 $params['extends'] == 'Phonecall' ||
845 $params['extends'] == 'Meeting' ||
846 $params['extends'] == 'Group' ||
847 $params['extends'] == 'Contribution'
849 ($params['style'] == 'Tab')
851 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
855 $dao = new $daoName();
856 $fields = $dao->fields();
859 foreach ($fields as $k => $v) {
860 if ($v['name'] == 'id') {
864 if (CRM_Utils_Array
::value('required', $v)) {
865 // 0 is a valid input for numbers, CRM-8122
866 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
872 if (!empty($missing)) {
873 if (!empty($return)) {
877 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
885 * Check permissions for a given API call.
887 * @param $entity string API entity being accessed
888 * @param $action string API action being performed
889 * @param $params array params of the API call
890 * @param $throw bool whether to throw exception instead of returning false
892 * @return bool whether the current API user has the permission to make the call
894 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
895 // return early unless we’re told explicitly to do the permission check
896 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
900 require_once 'CRM/Core/DAO/permissions.php';
901 $permissions = _civicrm_api3_permissions($entity, $action, $params);
903 // $params might’ve been reset by the alterAPIPermissions() hook
904 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
908 foreach ($permissions as $perm) {
909 if (!CRM_Core_Permission
::check($perm)) {
911 throw new Exception("API permission check failed for $entity/$action call; missing permission: $perm.");
922 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
924 * @param string $bao_name name of BAO
925 * @param array $params params from api
926 * @param bool $returnAsSuccess return in api success format
928 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
929 $bao = new $bao_name();
930 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
931 if ($returnAsSuccess) {
932 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
935 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
940 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
941 * @param string $bao_name Name of BAO Class
942 * @param array $params parameters passed into the api call
943 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
945 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
947 $args = array(&$params);
949 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
952 if (method_exists($bao_name, 'create')) {
955 elseif (method_exists($bao_name, 'add')) {
959 return civicrm_api3_create_error('Entity not created, missing create or add method for ' . $bao_name);
961 $bao = call_user_func_array(array($bao_name, $fct), $args);
963 return civicrm_api3_create_error('Entity not created ' . $bao_name . '::' . $fct);
967 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
968 return civicrm_api3_create_success($values, $params, NULL, 'create', $bao);
973 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
974 * if api::del doesn't exist it will try DAO delete method
976 function _civicrm_api3_basic_delete($bao_name, &$params) {
978 civicrm_api3_verify_mandatory($params, NULL, array('id'));
979 $args = array(&$params['id']);
980 if (method_exists($bao_name, 'del')) {
981 $bao = call_user_func_array(array($bao_name, 'del'), $args);
982 if ($bao !== FALSE) {
983 return civicrm_api3_create_success(TRUE);
985 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
987 elseif (method_exists($bao_name, 'delete')) {
988 $dao = new $bao_name();
989 $dao->id
= $params['id'];
991 while ($dao->fetch()) {
993 return civicrm_api3_create_success();
997 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
1001 return civicrm_api3_create_error('no delete method found');
1005 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1006 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1008 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1009 * @param string $entity e.g membership, event
1010 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1011 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1012 * @param string $subName - Subtype of entity
1015 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1016 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1017 CRM_Core_DAO
::$_nullObject,
1023 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1024 $customValues = array();
1025 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1026 if (!empty($customValues)) {
1027 foreach ($customValues as $key => $val) {
1028 if (strstr($key, '_id')) {
1029 $idkey = substr($key, 0, -3);
1030 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1031 $returnArray[$key] = $val;
1034 // per standard - return custom_fieldID
1035 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1037 //not standard - but some api did this so guess we should keep - cheap as chips
1038 $returnArray[$key] = $val;
1045 * Validate fields being passed into API. This function relies on the getFields function working accurately
1046 * for the given API. If error mode is set to TRUE then it will also check
1049 * As of writing only date was implemented.
1050 * @param string $entity
1051 * @param string $action
1052 * @param array $params -
1053 * all variables are the same as per civicrm_api
1055 function _civicrm_api3_validate_fields($entity, $action, &$params, $errorMode = NULL) {
1056 //skip any entities without working getfields functions
1057 $skippedEntities = array('entity', 'mailinggroup', 'customvalue', 'custom_value', 'mailing_group');
1058 if (in_array(strtolower($entity), $skippedEntities) ||
strtolower($action) == 'getfields') {
1061 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action));
1062 $fields = array_intersect_key($fields['values'], $params);
1063 foreach ($fields as $fieldName => $fieldInfo) {
1064 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1065 case CRM_Utils_Type
::T_INT
:
1066 //field is of type integer
1067 _civicrm_api3_validate_integer($params, $fieldName, $fieldInfo, $entity);
1072 //field is of type date or datetime
1073 _civicrm_api3_validate_date($params, $fieldName, $fieldInfo);
1077 _civicrm_api3_validate_html($params, $fieldName, $fieldInfo);
1080 case CRM_Utils_Type
::T_STRING
:
1081 _civicrm_api3_validate_string($params, $fieldName, $fieldInfo, $entity);
1084 case CRM_Utils_Type
::T_MONEY
:
1085 if (!CRM_Utils_Rule
::money($params[$fieldName])) {
1086 throw new Exception($fieldName . " is not a valid amount: " . $params[$fieldName]);
1090 // intensive checks - usually only called after DB level fail
1091 if (!empty($errorMode) && strtolower($action) == 'create') {
1092 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1093 if (CRM_Utils_Array
::value($fieldName, $params)) {
1094 _civicrm_api3_validate_constraint($params, $fieldName, $fieldInfo);
1096 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1097 throw new Exception("DB Constraint Violation - possibly $fieldName should possibly be marked as mandatory for this API. If so, please raise a bug report");
1100 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1101 $params['entity'] = $entity;
1102 _civicrm_api3_validate_uniquekey($params, $fieldName, $fieldInfo);
1109 * Validate date fields being passed into API.
1110 * It currently converts both unique fields and DB field names to a mysql date.
1111 * @todo - probably the unique field handling & the if exists handling is now done before this
1112 * function is reached in the wrapper - can reduce this code down to assume we
1113 * are only checking the passed in field
1115 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1116 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1118 * @param array $params params from civicrm_api
1119 * @param string $fieldName uniquename of field being checked
1120 * @param array $fieldinfo array of fields from getfields function
1122 function _civicrm_api3_validate_date(&$params, &$fieldName, &$fieldInfo) {
1123 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1124 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1125 //accept 'whatever strtotime accepts
1126 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1127 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1129 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1131 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldName) && CRM_Utils_Array
::value($fieldName, $params)) {
1132 //If the unique field name differs from the db name & is set handle it here
1133 if (strtotime($params[$fieldName]) === FALSE) {
1134 throw new Exception($fieldName . " is not a valid date: " . $params[$fieldName]);
1136 $params[$fieldName] = CRM_Utils_Date
::processDate($params[$fieldName]);
1141 * Validate foreign constraint fields being passed into API.
1143 * @param array $params params from civicrm_api
1144 * @param string $fieldName uniquename of field being checked
1145 * @param array $fieldinfo array of fields from getfields function
1147 function _civicrm_api3_validate_constraint(&$params, &$fieldName, &$fieldInfo) {
1148 $dao = new $fieldInfo['FKClassName'];
1149 $dao->id
= $params[$fieldName];
1151 $dao->selectAdd('id');
1152 if (!$dao->find()) {
1153 throw new Exception("$fieldName is not valid : " . $params[$fieldName]);
1158 * Validate foreign constraint fields being passed into API.
1160 * @param array $params params from civicrm_api
1161 * @param string $fieldName uniquename of field being checked
1162 * @param array $fieldinfo array of fields from getfields function
1164 function _civicrm_api3_validate_uniquekey(&$params, &$fieldName, &$fieldInfo) {
1165 $existing = civicrm_api($params['entity'], 'get', array(
1166 'version' => $params['version'],
1167 $fieldName => $params[$fieldName],
1169 // an entry already exists for this unique field
1170 if ($existing['count'] == 1) {
1171 // question - could this ever be a security issue?
1172 throw new Exception("Field: `$fieldName` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1177 * Generic implementation of the "replace" action.
1179 * Replace the old set of entities (matching some given keys) with a new set of
1180 * entities (matching the same keys).
1182 * Note: This will verify that 'values' is present, but it does not directly verify
1183 * any other parameters.
1185 * @param string $entity entity name
1186 * @param array $params params from civicrm_api, including:
1187 * - 'values': an array of records to save
1188 * - all other items: keys which identify new/pre-existing records
1190 function _civicrm_api3_generic_replace($entity, $params) {
1192 $transaction = new CRM_Core_Transaction();
1194 if (!is_array($params['values'])) {
1195 throw new Exception("Mandatory key(s) missing from params array: values");
1198 // Extract the keys -- somewhat scary, don't think too hard about it
1199 $baseParams = $params;
1200 unset($baseParams['values']);
1201 unset($baseParams['sequential']);
1203 // Lookup pre-existing records
1204 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1205 if (civicrm_error($preexisting)) {
1206 $transaction->rollback();
1207 return $preexisting;
1210 // Save the new/updated records
1212 foreach ($params['values'] as $replacement) {
1213 // Sugar: Don't force clients to duplicate the 'key' data
1214 $replacement = array_merge($baseParams, $replacement);
1215 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1216 $create = civicrm_api($entity, $action, $replacement);
1217 if (civicrm_error($create)) {
1218 $transaction->rollback();
1221 foreach ($create['values'] as $entity_id => $entity_value) {
1222 $creates[$entity_id] = $entity_value;
1226 // Remove stale records
1227 $staleIDs = array_diff(
1228 array_keys($preexisting['values']),
1229 array_keys($creates)
1231 foreach ($staleIDs as $staleID) {
1232 $delete = civicrm_api($entity, 'delete', array(
1233 'version' => $params['version'],
1236 if (civicrm_error($delete)) {
1237 $transaction->rollback();
1242 return civicrm_api3_create_success($creates, $params);
1244 catch(PEAR_Exception
$e) {
1245 $transaction->rollback();
1246 return civicrm_api3_create_error($e->getMessage());
1248 catch(Exception
$e) {
1249 $transaction->rollback();
1250 return civicrm_api3_create_error($e->getMessage());
1255 * returns fields allowable by api
1256 * @param $entity string Entity to query
1257 * @param bool $unique index by unique fields?
1259 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1261 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1262 $dao = _civicrm_api3_get_DAO($entity);
1267 $fields = $d->fields();
1268 // replace uniqueNames by the normal names as the key
1269 if (empty($unique)) {
1270 foreach ($fields as $name => & $field) {
1271 //getting rid of unused attributes
1272 foreach ($unsetIfEmpty as $attr) {
1273 if (empty($field[$attr])) {
1274 unset($field[$attr]);
1277 if ($name == $field['name']) {
1280 if (array_key_exists($field['name'], $fields)) {
1281 $field['error'] = 'name conflict';
1282 // it should never happen, but better safe than sorry
1285 $fields[$field['name']] = $field;
1286 $fields[$field['name']]['uniqueName'] = $name;
1287 unset($fields[$name]);
1290 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1295 * Return an array of fields for a given entity - this is the same as the BAO function but
1296 * fields are prefixed with 'custom_' to represent api params
1298 function _civicrm_api_get_custom_fields($entity, &$params) {
1299 $customfields = array();
1300 $entity = _civicrm_api_get_camel_name($entity);
1301 if (strtolower($entity) == 'contact') {
1302 $entity = CRM_Utils_Array
::value('contact_type', $params);
1304 $retrieveOnlyParent = FALSE;
1305 // we could / should probably test for other subtypes here - e.g. activity_type_id
1306 if($entity == 'Contact'){
1307 empty($params['contact_sub_type']);
1309 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1312 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1314 $retrieveOnlyParent,
1318 // find out if we have any requests to resolve options
1319 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1320 if(!is_array($getoptions)){
1321 $getoptions = array($getoptions);
1324 foreach ($customfields as $key => $value) {
1325 $customfields['custom_' . $key] = $value;
1326 if(in_array('custom_' . $key, $getoptions)){
1327 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1329 unset($customfields[$key]);
1331 return $customfields;
1335 * Return array of defaults for the given API (function is a wrapper on getfields)
1337 function _civicrm_api3_getdefaults($apiRequest) {
1338 $defaults = array();
1340 $result = civicrm_api($apiRequest['entity'],
1344 'action' => $apiRequest['action'],
1348 foreach ($result['values'] as $field => $values) {
1349 if (isset($values['api.default'])) {
1350 $defaults[$field] = $values['api.default'];
1357 * Return array of defaults for the given API (function is a wrapper on getfields)
1359 function _civicrm_api3_getrequired($apiRequest) {
1360 $required = array('version');
1362 $result = civicrm_api($apiRequest['entity'],
1366 'action' => $apiRequest['action'],
1369 foreach ($result['values'] as $field => $values) {
1370 if (CRM_Utils_Array
::value('api.required', $values)) {
1371 $required[] = $field;
1378 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1379 * If multiple aliases the last takes precedence
1381 * Function also swaps unique fields for non-unique fields & vice versa.
1383 function _civicrm_api3_swap_out_aliases(&$apiRequest) {
1384 if (strtolower($apiRequest['action'] == 'getfields')) {
1385 if (CRM_Utils_Array
::value('api_action', $apiRequest['params'])) {
1386 $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
1387 unset($apiRequest['params']['api_action']);
1391 $result = civicrm_api($apiRequest['entity'],
1395 'action' => $apiRequest['action'],
1399 foreach ($result['values'] as $field => $values) {
1400 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1401 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1402 // if aliased field is not set we try to use field alias
1403 if (!isset($apiRequest['params'][$field])) {
1404 foreach ($values['api.aliases'] as $alias) {
1405 if (isset($apiRequest['params'][$alias])) {
1406 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1408 //unset original field nb - need to be careful with this as it may bring inconsistencies
1409 // out of the woodwork but will be implementing only as _spec function extended
1410 unset($apiRequest['params'][$alias]);
1414 if (!isset($apiRequest['params'][$field])
1415 && CRM_Utils_Array
::value('name', $values)
1416 && $field != $values['name']
1417 && isset($apiRequest['params'][$values['name']])
1419 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1420 // note that it would make sense to unset the original field here but tests need to be in place first
1422 if (!isset($apiRequest['params'][$field])
1424 && $field != $uniqueName
1425 && array_key_exists($uniqueName, $apiRequest['params'])
1428 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1429 // note that it would make sense to unset the original field here but tests need to be in place first
1436 * Validate integer fields being passed into API.
1437 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1439 * @param array $params params from civicrm_api
1440 * @param string $fieldName uniquename of field being checked
1441 * @param array $fieldinfo array of fields from getfields function
1443 function _civicrm_api3_validate_integer(&$params, &$fieldName, &$fieldInfo, $entity) {
1444 //if fieldname exists in params
1445 if (CRM_Utils_Array
::value($fieldName, $params)) {
1446 //if value = 'user_contact_id' replace value with logged in user id
1447 if ($params[$fieldName] == "user_contact_id") {
1448 $session = &CRM_Core_Session
::singleton();
1449 $params[$fieldName] = $session->get('userID');
1451 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1452 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1455 // After swapping options, ensure we have an integer(s)
1456 foreach ((array) ($params[$fieldName]) as $value) {
1457 if (!is_numeric($value) ||
(int) $value != $value) {
1458 throw new API_Exception("$fieldName is not a valid integer", 2001, array('error_field' => $fieldName, "type" => "integer"));
1462 // Check our field length
1463 if(is_string($params[$fieldName]) &&
1464 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1465 && strlen($params[$fieldName]) > $fieldInfo['maxlength']
1467 throw new API_Exception( $params[$fieldName] . " is " . strlen($params[$fieldName]) . " characters - longer than $fieldName length" . $fieldInfo['maxlength'] . ' characters',
1468 2100, array('field' => $fieldName, "max_length"=>$fieldInfo['maxlength'])
1474 function _civicrm_api3_validate_html(&$params, &$fieldName, &$fieldInfo) {
1475 if ($value = CRM_Utils_Array
::value($fieldName, $params)) {
1476 if (!CRM_Utils_Rule
::xssString($value)) {
1477 throw new API_Exception('Illegal characters in input (potential scripting attack)',array("field"=>$fieldName,"error_code"=>"xss"));
1483 * Validate string fields being passed into API.
1484 * @param array $params params from civicrm_api
1485 * @param string $fieldName uniquename of field being checked
1486 * @param array $fieldinfo array of fields from getfields function
1488 function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $entity) {
1489 // If fieldname exists in params
1490 $value = CRM_Utils_Array
::value($fieldName, $params, '');
1491 if(!is_array($value)){
1492 $value = (string) $value;
1495 //@todo what do we do about passed in arrays. For many of these fields
1496 // the missing piece of functionality is separating them to a separated string
1497 // & many save incorrectly. But can we change them wholesale?
1500 if (!CRM_Utils_Rule
::xssString($value)) {
1501 throw new Exception('Illegal characters in input (potential scripting attack)');
1503 if ($fieldName == 'currency') {
1504 if (!CRM_Utils_Rule
::currencyCode($value)) {
1505 throw new Exception("Currency not a valid code: $value");
1508 if (!empty($fieldInfo['pseudoconstant']) ||
!empty($fieldInfo['options'])) {
1509 _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
1511 // Check our field length
1512 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1513 throw new API_Exception("Value for $fieldName is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1514 2100, array('field' => $fieldName)
1521 * Validate & swap out any pseudoconstants / options
1523 * @param $params: api parameters
1524 * @param $entity: api entity name
1525 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1526 * @param $fieldInfo: getfields meta-data
1528 function _civicrm_api3_api_match_pseudoconstant(&$params, $entity, $fieldName, $fieldInfo) {
1529 $options = CRM_Utils_Array
::value('options', $fieldInfo);
1531 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldInfo['name']));
1532 $options = CRM_Utils_Array
::value('values', $options, array());
1535 // If passed a value-seperated string, explode to an array, then re-implode after matching values
1537 if (is_string($params[$fieldName]) && strpos($params[$fieldName], CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
1538 $params[$fieldName] = CRM_Utils_Array
::explodePadded($params[$fieldName]);
1541 // If passed multiple options, validate each
1542 if (is_array($params[$fieldName])) {
1543 foreach ($params[$fieldName] as &$value) {
1544 _civicrm_api3_api_match_pseudoconstant_value($value, $options, $fieldName);
1546 // TODO: unwrap the call to implodePadded from the conditional and do it always
1547 // need to verify that this is safe and doesn't break anything though.
1548 // Better yet would be to leave it as an array and ensure that every dao/bao can handle array input
1550 CRM_Utils_Array
::implodePadded($params[$fieldName]);
1554 _civicrm_api3_api_match_pseudoconstant_value($params[$fieldName], $options, $fieldName);
1559 * Validate & swap a single option value for a field
1561 * @param $value: field value
1562 * @param $options: array of options for this field
1563 * @param $fieldName: field name used in api call (not necessarily the canonical name)
1565 function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldName) {
1566 // If option is a key, no need to translate
1567 if (isset($options[$value])) {
1571 // Case-insensitive matching
1572 $newValue = strtolower($value);
1573 $options = array_map("strtolower", $options);
1574 $newValue = array_search($newValue, $options);
1575 if ($newValue === FALSE) {
1576 throw new API_Exception("'$value' is not a valid option for field $fieldName", 2001, array('error_field' => $fieldName));
1582 * Returns the canonical name of a field
1583 * @param $entity: api entity
1584 * @param $fieldName: any variation of a field's name (name, unique_name, api.alias)
1586 * @return (string|bool) fieldName or FALSE if the field does not exist
1588 function _civicrm_api3_api_resolve_alias($entity, $fieldName) {
1589 $result = civicrm_api($entity, 'getfields', array(
1591 'action' => 'create',
1593 $meta = $result['values'];
1594 if (isset($meta[$fieldName])) {
1595 return $meta[$fieldName]['name'];
1597 if ($fieldName == "{$entity}_id") {
1600 foreach ($meta as $info) {
1601 if ($fieldName == CRM_Utils_Array
::value('uniqueName', $info)) {
1602 return $info['name'];
1604 if (array_search($fieldName, CRM_Utils_Array
::value('api.aliases', $info, array())) !== FALSE) {
1605 return $info['name'];