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/Config.php';
46 $config = CRM_Core_Config
::singleton();
50 * Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking
52 * @param array $params array of fields to check
53 * @param array $daoName string DAO to check for required fields (create functions only)
54 * @param array $keys list of required fields options. One of the options is required
55 * @return null or throws error if there the required fields not present
60 function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array(
62 $keys = array(array());
63 foreach ($keyoptions as $key) {
66 civicrm_api3_verify_mandatory($params, $daoName, $keys);
70 * Function to check mandatory fields are included
72 * @param array $params array of fields to check
73 * @param array $daoName string DAO to check for required fields (create functions only)
74 * @param array $keys list of required fields. A value can be an array denoting that either this or that is required.
75 * @param bool $verifyDAO
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));
132 * @param <type> $data
133 * @param object $dao DAO / BAO object to be freed here
137 function civicrm_api3_create_error($msg, $data = array(), &$dao = NULL) {
138 //fix me - $dao should be param 4 & 3 should be $apiRequest
139 if (is_object($dao)) {
143 if (is_array($dao)) {
144 if ($msg == 'DB Error: constraint violation' ||
substr($msg, 0,9) == 'DB Error:' ||
$msg == 'DB Error: already exists') {
146 _civicrm_api3_validate_fields($dao['entity'], $dao['action'], $dao['params'], TRUE);
148 catch(Exception
$e) {
149 $msg = $e->getMessage();
153 $data['is_error'] = 1;
154 $data['error_message'] = $msg;
155 if (is_array($dao) && isset($dao['params']) && is_array($dao['params']) && CRM_Utils_Array
::value('api.has_parent', $dao['params'])) {
156 $errorCode = empty($data['error_code']) ?
'chained_api_failed' : $data['error_code'];
157 throw new API_Exception('Error in call to ' . $dao['entity'] . '_' . $dao['action'] . ' : ' . $msg, $errorCode, $data);
163 * Format array in result output styple
165 * @param array $values values generated by API operation (the result)
166 * @param array $params parameters passed into API call
167 * @param string $entity the entity being acted on
168 * @param string $action the action passed to the API
169 * @param object $dao DAO object to be freed here
170 * @param array $extraReturnValues additional values to be added to top level of result array(
171 * - this param is currently used for legacy behaviour support
173 * @return array $result
175 function civicrm_api3_create_success($values = 1, $params = array(
176 ), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
178 $result['is_error'] = 0;
179 //lets set the ['id'] field if it's not set & we know what the entity is
180 if (is_array($values) && !empty($entity)) {
181 foreach ($values as $key => $item) {
182 if (empty($item['id']) && !empty($item[$entity . "_id"])) {
183 $values[$key]['id'] = $item[$entity . "_id"];
187 //if ( array_key_exists ('debug',$params) && is_object ($dao)) {
188 if (is_array($params) && array_key_exists('debug', $params)) {
189 if (!is_object($dao)) {
190 $d = _civicrm_api3_get_DAO(CRM_Utils_Array
::value('entity', $params));
192 $file = str_replace('_', '/', $d) . ".php";
193 require_once ($file);
197 if (is_string($action) && $action != 'getfields') {
198 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action) +
$params);
200 elseif ($action != 'getfields') {
201 $apiFields = civicrm_api($entity, 'getfields', array('version' => 3) +
$params);
207 $allFields = array();
208 if ($action != 'getfields' && is_array($apiFields) && is_array(CRM_Utils_Array
::value('values', $apiFields))) {
209 $allFields = array_keys($apiFields['values']);
211 $paramFields = array_keys($params);
212 $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'));
214 $result['undefined_fields'] = array_merge($undefined);
217 if (is_object($dao)) {
221 $result['version'] = 3;
222 if (is_array($values)) {
223 $result['count'] = count($values);
225 // Convert value-separated strings to array
226 _civicrm_api3_separate_values($values);
228 if ($result['count'] == 1) {
229 list($result['id']) = array_keys($values);
231 elseif (!empty($values['id']) && is_int($values['id'])) {
232 $result['id'] = $values['id'];
236 $result['count'] = !empty($values) ?
1 : 0;
239 if (is_array($values) && isset($params['sequential']) &&
240 $params['sequential'] == 1
242 $result['values'] = array_values($values);
245 $result['values'] = $values;
248 return array_merge($result, $extraReturnValues);
252 * Load the DAO of the entity
254 function _civicrm_api3_load_DAO($entity) {
255 $dao = _civicrm_api3_get_DAO($entity);
259 $file = str_replace('_', '/', $dao) . ".php";
260 require_once ($file);
266 * Function to return the DAO of the function or Entity
267 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
268 * return the DAO name to manipulate this function
269 * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
271 function _civicrm_api3_get_DAO($name) {
274 require ('CRM/Core/DAO/listAll.php');
277 if (strpos($name, 'civicrm_api3') !== FALSE) {
278 $last = strrpos($name, '_');
279 // len ('civicrm_api3_') == 13
280 $name = substr($name, 13, $last - 13);
283 if (strtolower($name) == 'individual' ||
strtolower($name) == 'household' ||
strtolower($name) == 'organization') {
287 //hack to deal with incorrectly named BAO/DAO - see CRM-10859 - remove after rename
288 if($name == 'price_set'){
289 return 'CRM_Price_DAO_Set';
291 if($name == 'price_field'){
292 return 'CRM_Price_DAO_Field';
294 if($name == 'price_field_value'){
295 return 'CRM_Price_DAO_FieldValue';
297 // these aren't listed on ticket CRM-10859 - but same problem - lack of standardisation
298 if($name == 'mailing_job' ||
$name == 'MailingJob'){
299 return 'CRM_Mailing_BAO_Job';
301 if($name == 'mailing_recipients' ||
$name == 'MailingRecipients'){
302 return 'CRM_Mailing_BAO_Recipients';
304 if(strtolower($name) == 'im'){
305 return 'CRM_Core_BAO_IM';
309 return CRM_Utils_Array
::value(_civicrm_api_get_camel_name($name, 3), $dao);
313 * Function to return the DAO of the function or Entity
314 * @param $name is either a function of the api (civicrm_{entity}_create or the entity name
315 * return the DAO name to manipulate this function
316 * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
318 function _civicrm_api3_get_BAO($name) {
319 $dao = _civicrm_api3_get_DAO($name);
320 $dao = str_replace("DAO", "BAO", $dao);
325 * Recursive function to explode value-separated strings into arrays
328 function _civicrm_api3_separate_values(&$values) {
329 $sp = CRM_Core_DAO
::VALUE_SEPARATOR
;
330 foreach ($values as $key => & $value) {
331 if (is_array($value)) {
332 _civicrm_api3_separate_values($value);
334 elseif (is_string($value)) {
335 if($key == 'case_type_id'){// this is to honor the way case API was originally written
336 $value = trim(str_replace($sp, ',', $value), ',');
338 elseif (strpos($value, $sp) !== FALSE) {
339 $value = explode($sp, trim($value, $sp));
346 * This is a wrapper for api_store_values which will check the suitable fields using getfields
347 * rather than DAO->fields
349 * Getfields has handling for how to deal with uniquenames which dao->fields doesn't
351 * Note this is used by BAO type create functions - eg. contribution
352 * @param string $entity
353 * @param array $params
354 * @param array $values
356 function _civicrm_api3_filter_fields_for_bao($entity, &$params, &$values){
357 $fields = civicrm_api($entity,'getfields', array('version' => 3,'action' => 'create'));
358 $fields = $fields['values'];
359 _civicrm_api3_store_values($fields, $params, $values);
363 * @param array $fields
364 * @param array $params
365 * @param array $values
367 * @return Bool $valueFound
369 function _civicrm_api3_store_values(&$fields, &$params, &$values) {
372 $keys = array_intersect_key($params, $fields);
373 foreach ($keys as $name => $value) {
374 if ($name !== 'id') {
375 $values[$name] = $value;
382 * The API supports 2 types of get requestion. The more complex uses the BAO query object.
383 * This is a generic function for those functions that call it
385 * At the moment only called by contact we should extend to contribution &
386 * others that use the query object. Note that this function passes permission information in.
389 * @param array $params as passed into api get or getcount function
390 * @param array $options array of options (so we can modify the filter)
391 * @param bool $getCount are we just after the count
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 $skipPermissions = CRM_Utils_Array
::value('check_permissions', $params)?
0 :1;
444 list($entities, $options) = CRM_Contact_BAO_Query
::apiQuery(
455 if ($getCount) { // only return the count of contacts
463 * Function transfers the filters being passed into the DAO onto the params object
465 function _civicrm_api3_dao_set_filter(&$dao, $params, $unique = TRUE, $entity) {
466 $entity = substr($dao->__table
, 8);
468 $allfields = _civicrm_api3_build_fields_array($dao, $unique);
470 $fields = array_intersect(array_keys($allfields), array_keys($params));
471 if (isset($params[$entity . "_id"])) {
472 //if entity_id is set then treat it as ID (will be overridden by id if set)
473 $dao->id
= $params[$entity . "_id"];
475 //apply options like sort
476 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
478 //accept filters like filter.activity_date_time_high
479 // std is now 'filters' => ..
480 if (strstr(implode(',', array_keys($params)), 'filter')) {
481 if (isset($params['filters']) && is_array($params['filters'])) {
482 foreach ($params['filters'] as $paramkey => $paramvalue) {
483 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
487 foreach ($params as $paramkey => $paramvalue) {
488 if (strstr($paramkey, 'filter')) {
489 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
494 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
495 // support for other syntaxes is discussed in ticket but being put off for now
496 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
501 foreach ($fields as $field) {
502 if (is_array($params[$field])) {
503 //get the actual fieldname from db
504 $fieldName = $allfields[$field]['name'];
505 //array is the syntax for SQL clause
506 foreach ($params[$field] as $operator => $criteria) {
507 if (in_array($operator, $acceptedSQLOperators)) {
513 $dao->whereAdd(sprintf('%s %s', $fieldName, $operator));
520 if (empty($criteria[0]) ||
empty($criteria[1])) {
521 throw new exception("invalid criteria for $operator");
523 $dao->whereAdd(sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
530 if (empty($criteria)) {
531 throw new exception("invalid criteria for $operator");
533 $escapedCriteria = array_map(array('CRM_Core_DAO', 'escapeString'), $criteria);
534 $dao->whereAdd(sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
541 $dao->whereAdd(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
548 $dao->$allfields[$field]['name'] = $params[$field];
551 $dao->$field = $params[$field];
555 if (!empty($params['return']) && is_array($params['return'])) {
557 $allfields = _civicrm_api3_get_unique_name_array($dao);
558 $returnMatched = array_intersect($params['return'], $allfields);
559 $returnUniqueMatched = array_intersect(
560 array_diff(// not already matched on the field names
563 array_flip($allfields)// but a match for the field keys
566 foreach ($returnMatched as $returnValue) {
567 $dao->selectAdd($returnValue);
569 foreach ($returnUniqueMatched as $uniqueVal){
570 $dao->selectAdd($allfields[$uniqueVal]);
573 $dao->selectAdd('id');
578 * Apply filters (e.g. high, low) to DAO object (prior to find)
579 * @param string $filterField field name of filter
580 * @param string $filterValue field value of filter
581 * @param object $dao DAO object
583 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
584 if (strstr($filterField, 'high')) {
585 $fieldName = substr($filterField, 0, -5);
586 $dao->whereAdd("($fieldName <= $filterValue )");
588 if (strstr($filterField, 'low')) {
589 $fieldName = substr($filterField, 0, -4);
590 $dao->whereAdd("($fieldName >= $filterValue )");
592 if($filterField == 'is_current' && $filterValue == 1){
593 $todayStart = date('Ymd000000', strtotime('now'));
594 $todayEnd = date('Ymd235959', strtotime('now'));
595 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
596 if(property_exists($dao, 'is_active')){
597 $dao->whereAdd('is_active = 1');
603 * Get sort, limit etc options from the params - supporting old & new formats.
604 * get returnproperties for legacy
605 * @param array $params params array as passed into civicrm_api
606 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
607 * for legacy report & return a unique fields array
608 * @return array $options options extracted from params
610 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
611 $sort = CRM_Utils_Array
::value('sort', $params, 0);
612 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
613 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
615 $offset = CRM_Utils_Array
::value('offset', $params, 0);
616 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
617 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
618 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
620 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
621 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
622 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
624 if (is_array(CRM_Utils_Array
::value('options', $params))) {
625 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
626 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
627 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
630 $returnProperties = array();
631 // handle the format return =sort_name,display_name...
632 if (array_key_exists('return', $params)) {
633 if (is_array($params['return'])) {
634 $returnProperties = array_fill_keys($params['return'], 1);
637 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
638 $returnProperties = array_fill_keys($returnProperties, 1);
641 if($entity && $action =='get' ){
642 if(CRM_Utils_Array
::value('id',$returnProperties)){
643 $returnProperties[$entity . '_id'] = 1;
644 unset($returnProperties['id']);
646 switch (trim(strtolower($sort))){
650 $sort = str_replace('id', $entity . '_id',$sort);
659 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
664 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
665 // if the queryobject is being used this should be used
666 $inputParams = array();
667 $legacyreturnProperties = array();
669 'sort', 'offset', 'rowCount', 'options','return',
671 foreach ($params as $n => $v) {
672 if (substr($n, 0, 7) == 'return.') {
673 $legacyreturnProperties[substr($n, 7)] = $v;
676 $inputParams[$entity. '_id'] = $v;
678 elseif (in_array($n, $otherVars)) {}
680 $inputParams[$n] = $v;
683 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
684 $options['input_params'] = $inputParams;
689 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
690 * @param array $params params array as passed into civicrm_api
691 * @param object $dao DAO object
693 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
695 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
696 $dao->limit((int)$options['offset'], (int)$options['limit']);
697 if (!empty($options['sort'])) {
698 $dao->orderBy($options['sort']);
703 * build fields array. This is the array of fields as it relates to the given DAO
704 * returns unique fields as keys by default but if set but can return by DB fields
706 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
707 $fields = $bao->fields();
709 if(!CRM_Utils_Array
::value('id', $fields)){
710 $entity = _civicrm_api_get_entity_name_from_dao($bao);
711 $fields['id'] = $fields[$entity . '_id'];
712 unset($fields[$entity . '_id']);
717 foreach ($fields as $field) {
718 $dbFields[$field['name']] = $field;
724 * build fields array. This is the array of fields as it relates to the given DAO
725 * returns unique fields as keys by default but if set but can return by DB fields
727 function _civicrm_api3_get_unique_name_array(&$bao) {
728 $fields = $bao->fields();
729 foreach ($fields as $field => $values) {
730 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
732 return $uniqueFields;
736 * Converts an DAO object to an array
738 * @param object $dao (reference )object to convert
739 * @params array of arrays (key = id) of array of fields
743 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
745 if (empty($dao) ||
!$dao->find()) {
749 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
750 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
751 foreach ($params['return'] as $return) {
752 if (substr($return, 0, 6) == 'custom') {
759 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
761 while ($dao->fetch()) {
763 foreach ($fields as $key) {
764 if (array_key_exists($key, $dao)) {
765 // not sure on that one
766 if ($dao->$key !== NULL) {
767 $tmp[$key] = $dao->$key;
771 $result[$dao->id
] = $tmp;
772 if (!empty($custom)) {
773 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
782 * Converts an object to an array
784 * @param object $dao (reference) object to convert
785 * @param array $values (reference) array
786 * @param array $uniqueFields
792 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
794 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
795 foreach ($fields as $key => $value) {
796 if (array_key_exists($key, $dao)) {
797 $values[$key] = $dao->$key;
803 * Wrapper for _civicrm_object_to_array when api supports unique fields
805 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
806 return _civicrm_api3_object_to_array($dao, $values, TRUE);
811 * @param array $params
812 * @param array $values
813 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
814 * @param string $entityId ID of entity per $extends
816 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
817 $values['custom'] = array();
818 foreach ($params as $key => $value) {
819 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
820 if ($customFieldID) {
821 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
822 $value, $extends, $customValueID, $entityId, FALSE, FALSE
830 * This function ensures that we have the right input parameters
832 * This function is only called when $dao is passed into verify_mandatory.
833 * The practice of passing $dao into verify_mandatory turned out to be
834 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
835 * api level. Hence the intention is to remove this function
836 * & the associated param from viery_mandatory
838 * @param array $params Associative array of property name/value
839 * pairs to insert in new history.
840 * @daoName string DAO to check params agains
842 * @return bool should the missing fields be returned as an array (core error created as default)
844 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
847 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
848 //@deprecated - see notes
849 if (isset($params['extends'])) {
850 if (($params['extends'] == 'Activity' ||
851 $params['extends'] == 'Phonecall' ||
852 $params['extends'] == 'Meeting' ||
853 $params['extends'] == 'Group' ||
854 $params['extends'] == 'Contribution'
856 ($params['style'] == 'Tab')
858 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
862 $dao = new $daoName();
863 $fields = $dao->fields();
866 foreach ($fields as $k => $v) {
867 if ($v['name'] == 'id') {
871 if (CRM_Utils_Array
::value('required', $v)) {
872 // 0 is a valid input for numbers, CRM-8122
873 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
879 if (!empty($missing)) {
880 if (!empty($return)) {
884 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
892 * Check permissions for a given API call.
894 * @param $entity string API entity being accessed
895 * @param $action string API action being performed
896 * @param $params array params of the API call
897 * @param $throw bool whether to throw exception instead of returning false
899 * @return bool whether the current API user has the permission to make the call
901 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
902 // return early unless we’re told explicitly to do the permission check
903 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
907 require_once 'CRM/Core/Permission.php';
909 require_once 'CRM/Core/DAO/permissions.php';
910 $permissions = _civicrm_api3_permissions($entity, $action, $params);
912 // $params might’ve been reset by the alterAPIPermissions() hook
913 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
917 foreach ($permissions as $perm) {
918 if (!CRM_Core_Permission
::check($perm)) {
920 throw new Exception("API permission check failed for $entity/$action call; missing permission: $perm.");
931 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
933 * @param string $bao_name name of BAO
934 * @param array $params params from api
935 * @param bool $returnAsSuccess return in api success format
937 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
938 $bao = new $bao_name();
939 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
940 if ($returnAsSuccess) {
941 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
944 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
949 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
950 * @param string $bao_name Name of BAO Class
951 * @param array $params parameters passed into the api call
952 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
954 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
956 $args = array(&$params);
958 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
961 if (method_exists($bao_name, 'create')) {
964 elseif (method_exists($bao_name, 'add')) {
968 return civicrm_api3_create_error('Entity not created, missing create or add method for ' . $bao_name);
970 $bao = call_user_func_array(array($bao_name, $fct), $args);
972 return civicrm_api3_create_error('Entity not created ' . $bao_name . '::' . $fct);
976 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
977 return civicrm_api3_create_success($values, $params, NULL, 'create', $bao);
982 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
983 * if api::del doesn't exist it will try DAO delete method
985 function _civicrm_api3_basic_delete($bao_name, &$params) {
987 civicrm_api3_verify_mandatory($params, NULL, array('id'));
988 $args = array(&$params['id']);
989 if (method_exists($bao_name, 'del')) {
990 $bao = call_user_func_array(array($bao_name, 'del'), $args);
991 if ($bao !== FALSE) {
992 return civicrm_api3_create_success(TRUE);
994 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
996 elseif (method_exists($bao_name, 'delete')) {
997 $dao = new $bao_name();
998 $dao->id
= $params['id'];
1000 while ($dao->fetch()) {
1002 return civicrm_api3_create_success();
1006 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
1010 return civicrm_api3_create_error('no delete method found');
1014 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1015 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1017 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1018 * @param string $entity e.g membership, event
1019 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1020 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1021 * @param string $subName - Subtype of entity
1024 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1025 require_once 'CRM/Core/BAO/CustomGroup.php';
1026 require_once 'CRM/Core/BAO/CustomField.php';
1027 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1028 CRM_Core_DAO
::$_nullObject,
1034 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1035 $customValues = array();
1036 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1037 if (!empty($customValues)) {
1038 foreach ($customValues as $key => $val) {
1039 if (strstr($key, '_id')) {
1040 $idkey = substr($key, 0, -3);
1041 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1042 $returnArray[$key] = $val;
1045 // per standard - return custom_fieldID
1046 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1048 //not standard - but some api did this so guess we should keep - cheap as chips
1049 $returnArray[$key] = $val;
1056 * Validate fields being passed into API. This function relies on the getFields function working accurately
1057 * for the given API. If error mode is set to TRUE then it will also check
1060 * As of writing only date was implemented.
1061 * @param string $entity
1062 * @param string $action
1063 * @param array $params -
1064 * all variables are the same as per civicrm_api
1066 function _civicrm_api3_validate_fields($entity, $action, &$params, $errorMode = NULL) {
1067 //skip any entities without working getfields functions
1068 $skippedEntities = array('entity', 'mailinggroup', 'customvalue', 'custom_value', 'mailing_group');
1069 if (in_array(strtolower($entity), $skippedEntities) ||
strtolower($action) == 'getfields') {
1072 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action));
1073 $fields = array_intersect_key($fields['values'], $params);
1074 foreach ($fields as $fieldname => $fieldInfo) {
1075 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1076 case CRM_Utils_Type
::T_INT
:
1077 //field is of type integer
1078 _civicrm_api3_validate_integer($params, $fieldname, $fieldInfo, $entity);
1083 //field is of type date or datetime
1084 _civicrm_api3_validate_date($params, $fieldname, $fieldInfo);
1087 _civicrm_api3_validate_html($params, $fieldname, $fieldInfo);
1089 case CRM_Utils_Type
::T_STRING
:
1091 _civicrm_api3_validate_string($params, $fieldname, $fieldInfo);
1094 case CRM_Utils_Type
::T_MONEY
:
1095 if (!CRM_Utils_Rule
::money($params[$fieldname])) {
1096 throw new Exception($fieldname . " is not a valid amount: " . $params[$fieldname]);
1100 // intensive checks - usually only called after DB level fail
1101 if (!empty($errorMode) && strtolower($action) == 'create') {
1102 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1103 if (CRM_Utils_Array
::value($fieldname, $params)) {
1104 _civicrm_api3_validate_constraint($params, $fieldname, $fieldInfo);
1106 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1107 throw new Exception("DB Constraint Violation - possibly $fieldname should possibly be marked as mandatory for this API. If so, please raise a bug report");
1110 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1111 $params['entity'] = $entity;
1112 _civicrm_api3_validate_uniquekey($params, $fieldname, $fieldInfo);
1119 * Validate date fields being passed into API.
1120 * It currently converts both unique fields and DB field names to a mysql date.
1121 * @todo - probably the unique field handling & the if exists handling is now done before this
1122 * function is reached in the wrapper - can reduce this code down to assume we
1123 * are only checking the passed in field
1125 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1126 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1128 * @param array $params params from civicrm_api
1129 * @param string $fieldname uniquename of field being checked
1130 * @param array $fieldinfo array of fields from getfields function
1132 function _civicrm_api3_validate_date(&$params, &$fieldname, &$fieldInfo) {
1133 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1134 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1135 //accept 'whatever strtotime accepts
1136 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1137 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1139 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1141 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldname) && CRM_Utils_Array
::value($fieldname, $params)) {
1142 //If the unique field name differs from the db name & is set handle it here
1143 if (strtotime($params[$fieldname]) === FALSE) {
1144 throw new Exception($fieldname . " is not a valid date: " . $params[$fieldname]);
1146 $params[$fieldname] = CRM_Utils_Date
::processDate($params[$fieldname]);
1151 * Validate foreign constraint fields being passed into API.
1153 * @param array $params params from civicrm_api
1154 * @param string $fieldname uniquename of field being checked
1155 * @param array $fieldinfo array of fields from getfields function
1157 function _civicrm_api3_validate_constraint(&$params, &$fieldname, &$fieldInfo) {
1158 $file = str_replace('_', '/', $fieldInfo['FKClassName']) . ".php";
1159 require_once ($file);
1160 $dao = new $fieldInfo['FKClassName'];
1161 $dao->id
= $params[$fieldname];
1163 $dao->selectAdd('id');
1164 if (!$dao->find()) {
1165 throw new Exception("$fieldname is not valid : " . $params[$fieldname]);
1170 * Validate foreign constraint fields being passed into API.
1172 * @param array $params params from civicrm_api
1173 * @param string $fieldname uniquename of field being checked
1174 * @param array $fieldinfo array of fields from getfields function
1176 function _civicrm_api3_validate_uniquekey(&$params, &$fieldname, &$fieldInfo) {
1177 $existing = civicrm_api($params['entity'], 'get', array(
1178 'version' => $params['version'],
1179 $fieldname => $params[$fieldname],
1181 // an entry already exists for this unique field
1182 if ($existing['count'] == 1) {
1183 // question - could this ever be a security issue?
1184 throw new Exception("Field: `$fieldname` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1189 * Generic implementation of the "replace" action.
1191 * Replace the old set of entities (matching some given keys) with a new set of
1192 * entities (matching the same keys).
1194 * Note: This will verify that 'values' is present, but it does not directly verify
1195 * any other parameters.
1197 * @param string $entity entity name
1198 * @param array $params params from civicrm_api, including:
1199 * - 'values': an array of records to save
1200 * - all other items: keys which identify new/pre-existing records
1202 function _civicrm_api3_generic_replace($entity, $params) {
1204 require_once 'CRM/Core/Transaction.php';
1205 $transaction = new CRM_Core_Transaction();
1207 if (!is_array($params['values'])) {
1208 throw new Exception("Mandatory key(s) missing from params array: values");
1211 // Extract the keys -- somewhat scary, don't think too hard about it
1212 $baseParams = $params;
1213 unset($baseParams['values']);
1214 unset($baseParams['sequential']);
1216 // Lookup pre-existing records
1217 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1218 if (civicrm_error($preexisting)) {
1219 $transaction->rollback();
1220 return $preexisting;
1223 // Save the new/updated records
1225 foreach ($params['values'] as $replacement) {
1226 // Sugar: Don't force clients to duplicate the 'key' data
1227 $replacement = array_merge($baseParams, $replacement);
1228 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1229 $create = civicrm_api($entity, $action, $replacement);
1230 if (civicrm_error($create)) {
1231 $transaction->rollback();
1234 foreach ($create['values'] as $entity_id => $entity_value) {
1235 $creates[$entity_id] = $entity_value;
1239 // Remove stale records
1240 $staleIDs = array_diff(
1241 array_keys($preexisting['values']),
1242 array_keys($creates)
1244 foreach ($staleIDs as $staleID) {
1245 $delete = civicrm_api($entity, 'delete', array(
1246 'version' => $params['version'],
1249 if (civicrm_error($delete)) {
1250 $transaction->rollback();
1255 return civicrm_api3_create_success($creates, $params);
1257 catch(PEAR_Exception
$e) {
1258 $transaction->rollback();
1259 return civicrm_api3_create_error($e->getMessage());
1261 catch(Exception
$e) {
1262 $transaction->rollback();
1263 return civicrm_api3_create_error($e->getMessage());
1268 * returns fields allowable by api
1269 * @param $entity string Entity to query
1270 * @param bool $unique index by unique fields?
1272 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1274 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1275 $dao = _civicrm_api3_get_DAO($entity);
1279 $file = str_replace('_', '/', $dao) . ".php";
1280 require_once ($file);
1282 $fields = $d->fields();
1283 // replace uniqueNames by the normal names as the key
1284 if (empty($unique)) {
1285 foreach ($fields as $name => & $field) {
1286 //getting rid of unused attributes
1287 foreach ($unsetIfEmpty as $attr) {
1288 if (empty($field[$attr])) {
1289 unset($field[$attr]);
1292 if ($name == $field['name']) {
1295 if (array_key_exists($field['name'], $fields)) {
1296 $field['error'] = 'name conflict';
1297 // it should never happen, but better safe than sorry
1300 $fields[$field['name']] = $field;
1301 $fields[$field['name']]['uniqueName'] = $name;
1302 unset($fields[$name]);
1305 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1310 * Return an array of fields for a given entity - this is the same as the BAO function but
1311 * fields are prefixed with 'custom_' to represent api params
1313 function _civicrm_api_get_custom_fields($entity, &$params) {
1314 require_once 'CRM/Core/BAO/CustomField.php';
1315 $customfields = array();
1316 $entity = _civicrm_api_get_camel_name($entity);
1317 if (strtolower($entity) == 'contact') {
1318 $entity = CRM_Utils_Array
::value('contact_type', $params);
1320 $retrieveOnlyParent = FALSE;
1321 // we could / should probably test for other subtypes here - e.g. activity_type_id
1322 if($entity == 'Contact'){
1323 empty($params['contact_sub_type']);
1325 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1328 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1330 $retrieveOnlyParent,
1334 // find out if we have any requests to resolve options
1335 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1336 if(!is_array($getoptions)){
1337 $getoptions = array($getoptions);
1340 foreach ($customfields as $key => $value) {
1341 $customfields['custom_' . $key] = $value;
1342 if(in_array('custom_' . $key, $getoptions)){
1343 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1345 unset($customfields[$key]);
1347 return $customfields;
1351 * Return array of defaults for the given API (function is a wrapper on getfields)
1353 function _civicrm_api3_getdefaults($apiRequest) {
1354 $defaults = array();
1356 $result = civicrm_api($apiRequest['entity'],
1360 'action' => $apiRequest['action'],
1364 foreach ($result['values'] as $field => $values) {
1365 if (isset($values['api.default'])) {
1366 $defaults[$field] = $values['api.default'];
1373 * Return array of defaults for the given API (function is a wrapper on getfields)
1375 function _civicrm_api3_getrequired($apiRequest) {
1376 $required = array('version');
1378 $result = civicrm_api($apiRequest['entity'],
1382 'action' => $apiRequest['action'],
1385 foreach ($result['values'] as $field => $values) {
1386 if (CRM_Utils_Array
::value('api.required', $values)) {
1387 $required[] = $field;
1394 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1395 * If multiple aliases the last takes precedence
1397 * Function also swaps unique fields for non-unique fields & vice versa.
1399 function _civicrm_api3_swap_out_aliases(&$apiRequest) {
1400 if (strtolower($apiRequest['action'] == 'getfields')) {
1401 if (CRM_Utils_Array
::value('api_action', $apiRequest['params'])) {
1402 $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
1403 unset($apiRequest['params']['api_action']);
1407 $result = civicrm_api($apiRequest['entity'],
1411 'action' => $apiRequest['action'],
1415 foreach ($result['values'] as $field => $values) {
1416 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1417 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1418 // if aliased field is not set we try to use field alias
1419 if (!isset($apiRequest['params'][$field])) {
1420 foreach ($values['api.aliases'] as $alias) {
1421 if (isset($apiRequest['params'][$alias])) {
1422 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1424 //unset original field nb - need to be careful with this as it may bring inconsistencies
1425 // out of the woodwork but will be implementing only as _spec function extended
1426 unset($apiRequest['params'][$alias]);
1430 if (!isset($apiRequest['params'][$field])
1431 && CRM_Utils_Array
::value('name', $values)
1432 && $field != $values['name']
1433 && isset($apiRequest['params'][$values['name']])
1435 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1436 // note that it would make sense to unset the original field here but tests need to be in place first
1438 if (!isset($apiRequest['params'][$field])
1440 && $field != $uniqueName
1441 && array_key_exists($uniqueName, $apiRequest['params'])
1444 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1445 // note that it would make sense to unset the original field here but tests need to be in place first
1452 * Validate integer fields being passed into API.
1453 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1455 * @param array $params params from civicrm_api
1456 * @param string $fieldname uniquename of field being checked
1457 * @param array $fieldinfo array of fields from getfields function
1459 function _civicrm_api3_validate_integer(&$params, &$fieldname, &$fieldInfo, $entity) {
1460 //if fieldname exists in params
1461 if (CRM_Utils_Array
::value($fieldname, $params)) {
1462 //if value = 'user_contact_id' replace value with logged in user id
1463 if ($params[$fieldname] == "user_contact_id") {
1464 $session = &CRM_Core_Session
::singleton();
1465 $params[$fieldname] = $session->get('userID');
1467 if (CRM_Utils_Array
::value('pseudoconstant', $fieldInfo) ) {
1468 $constant = CRM_Utils_Array
::value('options', $fieldInfo);
1469 if (is_numeric($params[$fieldname]) && !CRM_Utils_Array
::value('FKClassName',$fieldInfo) && !array_key_exists($params[$fieldname], $fieldInfo['options'])) {
1470 throw new API_Exception("$fieldname is not valid", 2001, array('error_field' => $fieldname,"type"=>"integer"));
1473 // we are looking for strings that should be swapped out e.g swap 'Donation' to financial_type_id 1
1474 if (!is_numeric($params[$fieldname]) && !is_array($params[$fieldname])) {
1475 if(CRM_Utils_Array
::value('FKClassName', $fieldInfo)){
1476 // we'll get the options for this now since we are doing a swap out
1477 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldname));
1478 if(empty($options['is_error'])){
1479 $fieldInfo['options'] = $options['values'];
1482 if(!empty($fieldInfo['options'])){
1483 $numericvalue = array_search($params[$fieldname], $fieldInfo['options']);
1484 if (empty($numericvalue)) {
1485 throw new Exception("$fieldname " . $params[$fieldname] . " is not valid");
1488 $params[$fieldname] = $numericvalue;
1493 // once we have done any swaps check our field length
1494 if(is_string($params[$fieldname]) &&
1495 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1496 && strlen($params[$fieldname]) > $fieldInfo['maxlength']
1498 throw new API_Exception( $params[$fieldname] . " is " . strlen($params[$fieldname]) . " characters - longer than $fieldname length" . $fieldInfo['maxlength'] . ' characters',
1499 2100, array('field' => $fieldname, "max_length"=>$fieldInfo['maxlength'])
1505 function _civicrm_api3_validate_html(&$params, &$fieldname, &$fieldInfo) {
1506 if ($value = CRM_Utils_Array
::value($fieldname, $params)) {
1507 if (!CRM_Utils_Rule
::xssString($value)) {
1508 throw new API_Exception('Illegal characters in input (potential scripting attack)',array("field"=>$fieldname,"error_code"=>"xss"));
1514 * Validate string fields being passed into API.
1515 * @param array $params params from civicrm_api
1516 * @param string $fieldname uniquename of field being checked
1517 * @param array $fieldinfo array of fields from getfields function
1519 function _civicrm_api3_validate_string(&$params, &$fieldname, &$fieldInfo) {
1520 // If fieldname exists in params
1521 $value = (string) CRM_Utils_Array
::value($fieldname, $params,'');
1523 if (!CRM_Utils_Rule
::xssString($value)) {
1524 throw new Exception('Illegal characters in input (potential scripting attack)');
1526 if ($fieldname == 'currency') {
1527 if (!CRM_Utils_Rule
::currencyCode($value)) {
1528 throw new Exception("Currency not a valid code: $value");
1531 if (!empty ($fieldInfo['options'])) {
1532 // Validate & swap out any pseudoconstants / options
1533 $options = $fieldInfo['options'];
1534 $lowerCaseOptions = array_map("strtolower", $options);
1535 // If value passed is not a key, it may be a label
1536 // Try to lookup key from label - if it can't be found throw error
1537 if (!isset($options[strtolower($value)]) && !isset($options[$value]) ) {
1538 if (!in_array(strtolower($value), $lowerCaseOptions)) {
1539 throw new Exception("$fieldname `$value` is not valid.");
1543 // Check our field length
1544 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1545 throw new API_Exception("Value for $fieldname is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1546 2100, array('field' => $fieldname)