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"];
462 //apply options like sort
463 _civicrm_api3_apply_options_to_dao($params, $dao, $entity);
465 //accept filters like filter.activity_date_time_high
466 // std is now 'filters' => ..
467 if (strstr(implode(',', array_keys($params)), 'filter')) {
468 if (isset($params['filters']) && is_array($params['filters'])) {
469 foreach ($params['filters'] as $paramkey => $paramvalue) {
470 _civicrm_api3_apply_filters_to_dao($paramkey, $paramvalue, $dao);
474 foreach ($params as $paramkey => $paramvalue) {
475 if (strstr($paramkey, 'filter')) {
476 _civicrm_api3_apply_filters_to_dao(substr($paramkey, 7), $paramvalue, $dao);
481 // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now
482 // support for other syntaxes is discussed in ticket but being put off for now
483 $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN');
488 foreach ($fields as $field) {
489 if (is_array($params[$field])) {
490 //get the actual fieldname from db
491 $fieldName = $allfields[$field]['name'];
492 //array is the syntax for SQL clause
493 foreach ($params[$field] as $operator => $criteria) {
494 if (in_array($operator, $acceptedSQLOperators)) {
500 $dao->whereAdd(sprintf('%s %s', $fieldName, $operator));
507 if (empty($criteria[0]) ||
empty($criteria[1])) {
508 throw new exception("invalid criteria for $operator");
510 $dao->whereAdd(sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO
::escapeString($criteria[0]), CRM_Core_DAO
::escapeString($criteria[1])));
517 if (empty($criteria)) {
518 throw new exception("invalid criteria for $operator");
520 $escapedCriteria = array_map(array('CRM_Core_DAO', 'escapeString'), $criteria);
521 $dao->whereAdd(sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria)));
528 $dao->whereAdd(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO
::escapeString($criteria)));
535 $daoFieldName = $allfields[$field]['name'];
536 if (empty($daoFieldName)) {
537 throw new API_Exception("Failed to determine field name for \"$field\"");
539 $dao->{$daoFieldName} = $params[$field];
542 $dao->$field = $params[$field];
546 if (!empty($params['return']) && is_array($params['return'])) {
548 $allfields = _civicrm_api3_get_unique_name_array($dao);
549 $returnMatched = array_intersect($params['return'], $allfields);
550 $returnUniqueMatched = array_intersect(
551 array_diff(// not already matched on the field names
554 array_flip($allfields)// but a match for the field keys
557 foreach ($returnMatched as $returnValue) {
558 $dao->selectAdd($returnValue);
560 foreach ($returnUniqueMatched as $uniqueVal){
561 $dao->selectAdd($allfields[$uniqueVal]);
564 $dao->selectAdd('id');
569 * Apply filters (e.g. high, low) to DAO object (prior to find)
570 * @param string $filterField field name of filter
571 * @param string $filterValue field value of filter
572 * @param object $dao DAO object
574 function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
575 if (strstr($filterField, 'high')) {
576 $fieldName = substr($filterField, 0, -5);
577 $dao->whereAdd("($fieldName <= $filterValue )");
579 if (strstr($filterField, 'low')) {
580 $fieldName = substr($filterField, 0, -4);
581 $dao->whereAdd("($fieldName >= $filterValue )");
583 if($filterField == 'is_current' && $filterValue == 1){
584 $todayStart = date('Ymd000000', strtotime('now'));
585 $todayEnd = date('Ymd235959', strtotime('now'));
586 $dao->whereAdd("(start_date <= '$todayStart' OR start_date IS NULL) AND (end_date >= '$todayEnd' OR end_date IS NULL)");
587 if(property_exists($dao, 'is_active')){
588 $dao->whereAdd('is_active = 1');
594 * Get sort, limit etc options from the params - supporting old & new formats.
595 * get returnproperties for legacy
596 * @param array $params params array as passed into civicrm_api
597 * @param bool $queryObject - is this supporting a queryobject api (e.g contact) - if so we support more options
598 * for legacy report & return a unique fields array
599 * @return array $options options extracted from params
601 function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
602 $sort = CRM_Utils_Array
::value('sort', $params, 0);
603 $sort = CRM_Utils_Array
::value('option.sort', $params, $sort);
604 $sort = CRM_Utils_Array
::value('option_sort', $params, $sort);
606 $offset = CRM_Utils_Array
::value('offset', $params, 0);
607 $offset = CRM_Utils_Array
::value('option.offset', $params, $offset);
608 // dear PHP thought it would be a good idea to transform a.b into a_b in the get/post
609 $offset = CRM_Utils_Array
::value('option_offset', $params, $offset);
611 $limit = CRM_Utils_Array
::value('rowCount', $params, 25);
612 $limit = CRM_Utils_Array
::value('option.limit', $params, $limit);
613 $limit = CRM_Utils_Array
::value('option_limit', $params, $limit);
615 if (is_array(CRM_Utils_Array
::value('options', $params))) {
616 $offset = CRM_Utils_Array
::value('offset', $params['options'], $offset);
617 $limit = CRM_Utils_Array
::value('limit', $params['options'], $limit);
618 $sort = CRM_Utils_Array
::value('sort', $params['options'], $sort);
621 $returnProperties = array();
622 // handle the format return =sort_name,display_name...
623 if (array_key_exists('return', $params)) {
624 if (is_array($params['return'])) {
625 $returnProperties = array_fill_keys($params['return'], 1);
628 $returnProperties = explode(',', str_replace(' ', '', $params['return']));
629 $returnProperties = array_fill_keys($returnProperties, 1);
632 if($entity && $action =='get' ){
633 if(CRM_Utils_Array
::value('id',$returnProperties)){
634 $returnProperties[$entity . '_id'] = 1;
635 unset($returnProperties['id']);
637 switch (trim(strtolower($sort))){
641 $sort = str_replace('id', $entity . '_id',$sort);
650 'return' => !empty($returnProperties) ?
$returnProperties : NULL,
655 //here comes the legacy support for $returnProperties, $inputParams e.g for contat_get
656 // if the queryobject is being used this should be used
657 $inputParams = array();
658 $legacyreturnProperties = array();
660 'sort', 'offset', 'rowCount', 'options','return',
662 foreach ($params as $n => $v) {
663 if (substr($n, 0, 7) == 'return.') {
664 $legacyreturnProperties[substr($n, 7)] = $v;
667 $inputParams[$entity. '_id'] = $v;
669 elseif (in_array($n, $otherVars)) {}
671 $inputParams[$n] = $v;
674 $options['return'] = array_merge($returnProperties, $legacyreturnProperties);
675 $options['input_params'] = $inputParams;
680 * Apply options (e.g. sort, limit, order by) to DAO object (prior to find)
681 * @param array $params params array as passed into civicrm_api
682 * @param object $dao DAO object
684 function _civicrm_api3_apply_options_to_dao(&$params, &$dao, $entity) {
686 $options = _civicrm_api3_get_options_from_params($params,FALSE,$entity);
687 $dao->limit((int)$options['offset'], (int)$options['limit']);
688 if (!empty($options['sort'])) {
689 $dao->orderBy($options['sort']);
694 * build fields array. This is the array of fields as it relates to the given DAO
695 * returns unique fields as keys by default but if set but can return by DB fields
697 function _civicrm_api3_build_fields_array(&$bao, $unique = TRUE) {
698 $fields = $bao->fields();
700 if(!CRM_Utils_Array
::value('id', $fields)){
701 $entity = _civicrm_api_get_entity_name_from_dao($bao);
702 $fields['id'] = $fields[$entity . '_id'];
703 unset($fields[$entity . '_id']);
708 foreach ($fields as $field) {
709 $dbFields[$field['name']] = $field;
715 * build fields array. This is the array of fields as it relates to the given DAO
716 * returns unique fields as keys by default but if set but can return by DB fields
718 function _civicrm_api3_get_unique_name_array(&$bao) {
719 $fields = $bao->fields();
720 foreach ($fields as $field => $values) {
721 $uniqueFields[$field] = CRM_Utils_Array
::value('name',$values, $field);
723 return $uniqueFields;
727 * Converts an DAO object to an array
729 * @param object $dao (reference )object to convert
730 * @params array of arrays (key = id) of array of fields
734 function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "") {
736 if (empty($dao) ||
!$dao->find()) {
740 //if custom fields are required we will endeavour to set them . NB passing $entity in might be a bit clunky / unrequired
741 if (!empty($entity) && CRM_Utils_Array
::value('return', $params) && is_array($params['return'])) {
742 foreach ($params['return'] as $return) {
743 if (substr($return, 0, 6) == 'custom') {
750 $fields = array_keys(_civicrm_api3_build_fields_array($dao, $uniqueFields));
752 while ($dao->fetch()) {
754 foreach ($fields as $key) {
755 if (array_key_exists($key, $dao)) {
756 // not sure on that one
757 if ($dao->$key !== NULL) {
758 $tmp[$key] = $dao->$key;
762 $result[$dao->id
] = $tmp;
763 if (!empty($custom)) {
764 _civicrm_api3_custom_data_get($result[$dao->id
], $entity, $dao->id
);
773 * Converts an object to an array
775 * @param object $dao (reference) object to convert
776 * @param array $values (reference) array
777 * @param array $uniqueFields
783 function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
785 $fields = _civicrm_api3_build_fields_array($dao, $uniqueFields);
786 foreach ($fields as $key => $value) {
787 if (array_key_exists($key, $dao)) {
788 $values[$key] = $dao->$key;
794 * Wrapper for _civicrm_object_to_array when api supports unique fields
796 function _civicrm_api3_object_to_array_unique_fields(&$dao, &$values) {
797 return _civicrm_api3_object_to_array($dao, $values, TRUE);
802 * @param array $params
803 * @param array $values
804 * @param string $extends entity that this custom field extends (e.g. contribution, event, contact)
805 * @param string $entityId ID of entity per $extends
807 function _civicrm_api3_custom_format_params($params, &$values, $extends, $entityId = NULL) {
808 $values['custom'] = array();
809 foreach ($params as $key => $value) {
810 list($customFieldID, $customValueID) = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE);
811 if ($customFieldID) {
812 CRM_Core_BAO_CustomField
::formatCustomField($customFieldID, $values['custom'],
813 $value, $extends, $customValueID, $entityId, FALSE, FALSE
821 * This function ensures that we have the right input parameters
823 * This function is only called when $dao is passed into verify_mandatory.
824 * The practice of passing $dao into verify_mandatory turned out to be
825 * unsatisfactory as the required fields @ the dao level is so diffent to the abstract
826 * api level. Hence the intention is to remove this function
827 * & the associated param from viery_mandatory
829 * @param array $params Associative array of property name/value
830 * pairs to insert in new history.
831 * @daoName string DAO to check params agains
833 * @return bool should the missing fields be returned as an array (core error created as default)
835 * @return bool true if all fields present, depending on $result a core error is created of an array of missing fields is returned
838 function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
839 //@deprecated - see notes
840 if (isset($params['extends'])) {
841 if (($params['extends'] == 'Activity' ||
842 $params['extends'] == 'Phonecall' ||
843 $params['extends'] == 'Meeting' ||
844 $params['extends'] == 'Group' ||
845 $params['extends'] == 'Contribution'
847 ($params['style'] == 'Tab')
849 return civicrm_api3_create_error(ts("Can not create Custom Group in Tab for " . $params['extends']));
853 $dao = new $daoName();
854 $fields = $dao->fields();
857 foreach ($fields as $k => $v) {
858 if ($v['name'] == 'id') {
862 if (CRM_Utils_Array
::value('required', $v)) {
863 // 0 is a valid input for numbers, CRM-8122
864 if (!isset($params[$k]) ||
(empty($params[$k]) && !($params[$k] === 0))) {
870 if (!empty($missing)) {
871 if (!empty($return)) {
875 return civicrm_api3_create_error(ts("Required fields " . implode(',', $missing) . " for $daoName are not present"));
883 * Check permissions for a given API call.
885 * @param $entity string API entity being accessed
886 * @param $action string API action being performed
887 * @param $params array params of the API call
888 * @param $throw bool whether to throw exception instead of returning false
890 * @return bool whether the current API user has the permission to make the call
892 function _civicrm_api3_api_check_permission($entity, $action, &$params, $throw = TRUE) {
893 // return early unless we’re told explicitly to do the permission check
894 if (empty($params['check_permissions']) or $params['check_permissions'] == FALSE) {
898 require_once 'CRM/Core/DAO/permissions.php';
899 $permissions = _civicrm_api3_permissions($entity, $action, $params);
901 // $params might’ve been reset by the alterAPIPermissions() hook
902 if (isset($params['check_permissions']) and $params['check_permissions'] == FALSE) {
906 foreach ($permissions as $perm) {
907 if (!CRM_Core_Permission
::check($perm)) {
909 throw new Exception("API permission check failed for $entity/$action call; missing permission: $perm.");
920 * Function to do a 'standard' api get - when the api is only doing a $bao->find then use this
922 * @param string $bao_name name of BAO
923 * @param array $params params from api
924 * @param bool $returnAsSuccess return in api success format
926 function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $entity = "") {
927 $bao = new $bao_name();
928 _civicrm_api3_dao_set_filter($bao, $params, TRUE,$entity);
929 if ($returnAsSuccess) {
930 return civicrm_api3_create_success(_civicrm_api3_dao_to_array($bao, $params, FALSE, $entity), $params, $entity);
933 return _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity);
938 * Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
939 * @param string $bao_name Name of BAO Class
940 * @param array $params parameters passed into the api call
941 * @param string $entity Entity - pass in if entity is non-standard & required $ids array
943 function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
945 $args = array(&$params);
947 $ids = array($entity => CRM_Utils_Array
::value('id', $params));
950 if (method_exists($bao_name, 'create')) {
953 elseif (method_exists($bao_name, 'add')) {
957 return civicrm_api3_create_error('Entity not created, missing create or add method for ' . $bao_name);
959 $bao = call_user_func_array(array($bao_name, $fct), $args);
961 return civicrm_api3_create_error('Entity not created ' . $bao_name . '::' . $fct);
965 _civicrm_api3_object_to_array($bao, $values[$bao->id
]);
966 return civicrm_api3_create_success($values, $params, NULL, 'create', $bao);
971 * Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
972 * if api::del doesn't exist it will try DAO delete method
974 function _civicrm_api3_basic_delete($bao_name, &$params) {
976 civicrm_api3_verify_mandatory($params, NULL, array('id'));
977 $args = array(&$params['id']);
978 if (method_exists($bao_name, 'del')) {
979 $bao = call_user_func_array(array($bao_name, 'del'), $args);
980 if ($bao !== FALSE) {
981 return civicrm_api3_create_success(TRUE);
983 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
985 elseif (method_exists($bao_name, 'delete')) {
986 $dao = new $bao_name();
987 $dao->id
= $params['id'];
989 while ($dao->fetch()) {
991 return civicrm_api3_create_success();
995 return civicrm_api3_create_error('Could not delete entity id ' . $params['id']);
999 return civicrm_api3_create_error('no delete method found');
1003 * Get custom data for the given entity & Add it to the returnArray as 'custom_123' = 'custom string' AND 'custom_123_1' = 'custom string'
1004 * Where 123 is field value & 1 is the id within the custom group data table (value ID)
1006 * @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
1007 * @param string $entity e.g membership, event
1008 * @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
1009 * @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
1010 * @param string $subName - Subtype of entity
1013 function _civicrm_api3_custom_data_get(&$returnArray, $entity, $entity_id, $groupID = NULL, $subType = NULL, $subName = NULL) {
1014 $groupTree = &CRM_Core_BAO_CustomGroup
::getTree($entity,
1015 CRM_Core_DAO
::$_nullObject,
1021 $groupTree = CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, CRM_Core_DAO
::$_nullObject);
1022 $customValues = array();
1023 CRM_Core_BAO_CustomGroup
::setDefaults($groupTree, $customValues);
1024 if (!empty($customValues)) {
1025 foreach ($customValues as $key => $val) {
1026 if (strstr($key, '_id')) {
1027 $idkey = substr($key, 0, -3);
1028 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($idkey) . "_id")] = $val;
1029 $returnArray[$key] = $val;
1032 // per standard - return custom_fieldID
1033 $returnArray['custom_' . (CRM_Core_BAO_CustomField
::getKeyID($key))] = $val;
1035 //not standard - but some api did this so guess we should keep - cheap as chips
1036 $returnArray[$key] = $val;
1043 * Validate fields being passed into API. This function relies on the getFields function working accurately
1044 * for the given API. If error mode is set to TRUE then it will also check
1047 * As of writing only date was implemented.
1048 * @param string $entity
1049 * @param string $action
1050 * @param array $params -
1051 * all variables are the same as per civicrm_api
1053 function _civicrm_api3_validate_fields($entity, $action, &$params, $errorMode = NULL) {
1054 //skip any entities without working getfields functions
1055 $skippedEntities = array('entity', 'mailinggroup', 'customvalue', 'custom_value', 'mailing_group');
1056 if (in_array(strtolower($entity), $skippedEntities) ||
strtolower($action) == 'getfields') {
1059 $fields = civicrm_api($entity, 'getfields', array('version' => 3, 'action' => $action));
1060 $fields = array_intersect_key($fields['values'], $params);
1061 foreach ($fields as $fieldname => $fieldInfo) {
1062 switch (CRM_Utils_Array
::value('type', $fieldInfo)) {
1063 case CRM_Utils_Type
::T_INT
:
1064 //field is of type integer
1065 _civicrm_api3_validate_integer($params, $fieldname, $fieldInfo, $entity);
1070 //field is of type date or datetime
1071 _civicrm_api3_validate_date($params, $fieldname, $fieldInfo);
1074 _civicrm_api3_validate_html($params, $fieldname, $fieldInfo);
1076 case CRM_Utils_Type
::T_STRING
:
1078 _civicrm_api3_validate_string($params, $fieldname, $fieldInfo);
1081 case CRM_Utils_Type
::T_MONEY
:
1082 if (!CRM_Utils_Rule
::money($params[$fieldname])) {
1083 throw new Exception($fieldname . " is not a valid amount: " . $params[$fieldname]);
1087 // intensive checks - usually only called after DB level fail
1088 if (!empty($errorMode) && strtolower($action) == 'create') {
1089 if (CRM_Utils_Array
::value('FKClassName', $fieldInfo)) {
1090 if (CRM_Utils_Array
::value($fieldname, $params)) {
1091 _civicrm_api3_validate_constraint($params, $fieldname, $fieldInfo);
1093 elseif (CRM_Utils_Array
::value('required', $fieldInfo)) {
1094 throw new Exception("DB Constraint Violation - possibly $fieldname should possibly be marked as mandatory for this API. If so, please raise a bug report");
1097 if (CRM_Utils_Array
::value('api.unique', $fieldInfo)) {
1098 $params['entity'] = $entity;
1099 _civicrm_api3_validate_uniquekey($params, $fieldname, $fieldInfo);
1106 * Validate date fields being passed into API.
1107 * It currently converts both unique fields and DB field names to a mysql date.
1108 * @todo - probably the unique field handling & the if exists handling is now done before this
1109 * function is reached in the wrapper - can reduce this code down to assume we
1110 * are only checking the passed in field
1112 * It also checks against the RULE:date function. This is a centralisation of code that was scattered and
1113 * may not be the best thing to do. There is no code level documentation on the existing functions to work off
1115 * @param array $params params from civicrm_api
1116 * @param string $fieldname uniquename of field being checked
1117 * @param array $fieldinfo array of fields from getfields function
1119 function _civicrm_api3_validate_date(&$params, &$fieldname, &$fieldInfo) {
1120 //should we check first to prevent it from being copied if they have passed in sql friendly format?
1121 if (CRM_Utils_Array
::value($fieldInfo['name'], $params)) {
1122 //accept 'whatever strtotime accepts
1123 if (strtotime($params[$fieldInfo['name']]) === FALSE) {
1124 throw new Exception($fieldInfo['name'] . " is not a valid date: " . $params[$fieldInfo['name']]);
1126 $params[$fieldInfo['name']] = CRM_Utils_Date
::processDate($params[$fieldInfo['name']]);
1128 if ((CRM_Utils_Array
::value('name', $fieldInfo) != $fieldname) && CRM_Utils_Array
::value($fieldname, $params)) {
1129 //If the unique field name differs from the db name & is set handle it here
1130 if (strtotime($params[$fieldname]) === FALSE) {
1131 throw new Exception($fieldname . " is not a valid date: " . $params[$fieldname]);
1133 $params[$fieldname] = CRM_Utils_Date
::processDate($params[$fieldname]);
1138 * Validate foreign constraint fields being passed into API.
1140 * @param array $params params from civicrm_api
1141 * @param string $fieldname uniquename of field being checked
1142 * @param array $fieldinfo array of fields from getfields function
1144 function _civicrm_api3_validate_constraint(&$params, &$fieldname, &$fieldInfo) {
1145 $dao = new $fieldInfo['FKClassName'];
1146 $dao->id
= $params[$fieldname];
1148 $dao->selectAdd('id');
1149 if (!$dao->find()) {
1150 throw new Exception("$fieldname is not valid : " . $params[$fieldname]);
1155 * Validate foreign constraint fields being passed into API.
1157 * @param array $params params from civicrm_api
1158 * @param string $fieldname uniquename of field being checked
1159 * @param array $fieldinfo array of fields from getfields function
1161 function _civicrm_api3_validate_uniquekey(&$params, &$fieldname, &$fieldInfo) {
1162 $existing = civicrm_api($params['entity'], 'get', array(
1163 'version' => $params['version'],
1164 $fieldname => $params[$fieldname],
1166 // an entry already exists for this unique field
1167 if ($existing['count'] == 1) {
1168 // question - could this ever be a security issue?
1169 throw new Exception("Field: `$fieldname` must be unique. An conflicting entity already exists - id: " . $existing['id']);
1174 * Generic implementation of the "replace" action.
1176 * Replace the old set of entities (matching some given keys) with a new set of
1177 * entities (matching the same keys).
1179 * Note: This will verify that 'values' is present, but it does not directly verify
1180 * any other parameters.
1182 * @param string $entity entity name
1183 * @param array $params params from civicrm_api, including:
1184 * - 'values': an array of records to save
1185 * - all other items: keys which identify new/pre-existing records
1187 function _civicrm_api3_generic_replace($entity, $params) {
1189 $transaction = new CRM_Core_Transaction();
1191 if (!is_array($params['values'])) {
1192 throw new Exception("Mandatory key(s) missing from params array: values");
1195 // Extract the keys -- somewhat scary, don't think too hard about it
1196 $baseParams = $params;
1197 unset($baseParams['values']);
1198 unset($baseParams['sequential']);
1200 // Lookup pre-existing records
1201 $preexisting = civicrm_api($entity, 'get', $baseParams, $params);
1202 if (civicrm_error($preexisting)) {
1203 $transaction->rollback();
1204 return $preexisting;
1207 // Save the new/updated records
1209 foreach ($params['values'] as $replacement) {
1210 // Sugar: Don't force clients to duplicate the 'key' data
1211 $replacement = array_merge($baseParams, $replacement);
1212 $action = (isset($replacement['id']) ||
isset($replacement[$entity . '_id'])) ?
'update' : 'create';
1213 $create = civicrm_api($entity, $action, $replacement);
1214 if (civicrm_error($create)) {
1215 $transaction->rollback();
1218 foreach ($create['values'] as $entity_id => $entity_value) {
1219 $creates[$entity_id] = $entity_value;
1223 // Remove stale records
1224 $staleIDs = array_diff(
1225 array_keys($preexisting['values']),
1226 array_keys($creates)
1228 foreach ($staleIDs as $staleID) {
1229 $delete = civicrm_api($entity, 'delete', array(
1230 'version' => $params['version'],
1233 if (civicrm_error($delete)) {
1234 $transaction->rollback();
1239 return civicrm_api3_create_success($creates, $params);
1241 catch(PEAR_Exception
$e) {
1242 $transaction->rollback();
1243 return civicrm_api3_create_error($e->getMessage());
1245 catch(Exception
$e) {
1246 $transaction->rollback();
1247 return civicrm_api3_create_error($e->getMessage());
1252 * returns fields allowable by api
1253 * @param $entity string Entity to query
1254 * @param bool $unique index by unique fields?
1256 function _civicrm_api_get_fields($entity, $unique = FALSE, &$params = array(
1258 $unsetIfEmpty = array('dataPattern', 'headerPattern', 'default', 'export', 'import');
1259 $dao = _civicrm_api3_get_DAO($entity);
1264 $fields = $d->fields();
1265 // replace uniqueNames by the normal names as the key
1266 if (empty($unique)) {
1267 foreach ($fields as $name => & $field) {
1268 //getting rid of unused attributes
1269 foreach ($unsetIfEmpty as $attr) {
1270 if (empty($field[$attr])) {
1271 unset($field[$attr]);
1274 if ($name == $field['name']) {
1277 if (array_key_exists($field['name'], $fields)) {
1278 $field['error'] = 'name conflict';
1279 // it should never happen, but better safe than sorry
1282 $fields[$field['name']] = $field;
1283 $fields[$field['name']]['uniqueName'] = $name;
1284 unset($fields[$name]);
1287 $fields +
= _civicrm_api_get_custom_fields($entity, $params);
1292 * Return an array of fields for a given entity - this is the same as the BAO function but
1293 * fields are prefixed with 'custom_' to represent api params
1295 function _civicrm_api_get_custom_fields($entity, &$params) {
1296 $customfields = array();
1297 $entity = _civicrm_api_get_camel_name($entity);
1298 if (strtolower($entity) == 'contact') {
1299 $entity = CRM_Utils_Array
::value('contact_type', $params);
1301 $retrieveOnlyParent = FALSE;
1302 // we could / should probably test for other subtypes here - e.g. activity_type_id
1303 if($entity == 'Contact'){
1304 empty($params['contact_sub_type']);
1306 $customfields = CRM_Core_BAO_CustomField
::getFields($entity,
1309 CRM_Utils_Array
::value('contact_sub_type', $params, FALSE),
1311 $retrieveOnlyParent,
1315 // find out if we have any requests to resolve options
1316 $getoptions = CRM_Utils_Array
::value('get_options', CRM_Utils_Array
::value('options',$params));
1317 if(!is_array($getoptions)){
1318 $getoptions = array($getoptions);
1321 foreach ($customfields as $key => $value) {
1322 $customfields['custom_' . $key] = $value;
1323 if(in_array('custom_' . $key, $getoptions)){
1324 $customfields['custom_' . $key]['options'] = CRM_Core_BAO_CustomOption
::valuesByID($key);
1326 unset($customfields[$key]);
1328 return $customfields;
1332 * Return array of defaults for the given API (function is a wrapper on getfields)
1334 function _civicrm_api3_getdefaults($apiRequest) {
1335 $defaults = array();
1337 $result = civicrm_api($apiRequest['entity'],
1341 'action' => $apiRequest['action'],
1345 foreach ($result['values'] as $field => $values) {
1346 if (isset($values['api.default'])) {
1347 $defaults[$field] = $values['api.default'];
1354 * Return array of defaults for the given API (function is a wrapper on getfields)
1356 function _civicrm_api3_getrequired($apiRequest) {
1357 $required = array('version');
1359 $result = civicrm_api($apiRequest['entity'],
1363 'action' => $apiRequest['action'],
1366 foreach ($result['values'] as $field => $values) {
1367 if (CRM_Utils_Array
::value('api.required', $values)) {
1368 $required[] = $field;
1375 * Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't
1376 * If multiple aliases the last takes precedence
1378 * Function also swaps unique fields for non-unique fields & vice versa.
1380 function _civicrm_api3_swap_out_aliases(&$apiRequest) {
1381 if (strtolower($apiRequest['action'] == 'getfields')) {
1382 if (CRM_Utils_Array
::value('api_action', $apiRequest['params'])) {
1383 $apiRequest['params']['action'] = $apiRequest['params']['api_action'];
1384 unset($apiRequest['params']['api_action']);
1388 $result = civicrm_api($apiRequest['entity'],
1392 'action' => $apiRequest['action'],
1396 foreach ($result['values'] as $field => $values) {
1397 $uniqueName = CRM_Utils_Array
::value('uniqueName', $values);
1398 if (CRM_Utils_Array
::value('api.aliases', $values)) {
1399 // if aliased field is not set we try to use field alias
1400 if (!isset($apiRequest['params'][$field])) {
1401 foreach ($values['api.aliases'] as $alias) {
1402 if (isset($apiRequest['params'][$alias])) {
1403 $apiRequest['params'][$field] = $apiRequest['params'][$alias];
1405 //unset original field nb - need to be careful with this as it may bring inconsistencies
1406 // out of the woodwork but will be implementing only as _spec function extended
1407 unset($apiRequest['params'][$alias]);
1411 if (!isset($apiRequest['params'][$field])
1412 && CRM_Utils_Array
::value('name', $values)
1413 && $field != $values['name']
1414 && isset($apiRequest['params'][$values['name']])
1416 $apiRequest['params'][$field] = $apiRequest['params'][$values['name']];
1417 // note that it would make sense to unset the original field here but tests need to be in place first
1419 if (!isset($apiRequest['params'][$field])
1421 && $field != $uniqueName
1422 && array_key_exists($uniqueName, $apiRequest['params'])
1425 $apiRequest['params'][$field] = CRM_Utils_Array
::value($values['uniqueName'], $apiRequest['params']);
1426 // note that it would make sense to unset the original field here but tests need to be in place first
1433 * Validate integer fields being passed into API.
1434 * It currently converts the incoming value 'user_contact_id' into the id of the currenty logged in user
1436 * @param array $params params from civicrm_api
1437 * @param string $fieldname uniquename of field being checked
1438 * @param array $fieldinfo array of fields from getfields function
1440 function _civicrm_api3_validate_integer(&$params, &$fieldname, &$fieldInfo, $entity) {
1441 //if fieldname exists in params
1442 if (CRM_Utils_Array
::value($fieldname, $params)) {
1443 //if value = 'user_contact_id' replace value with logged in user id
1444 if ($params[$fieldname] == "user_contact_id") {
1445 $session = &CRM_Core_Session
::singleton();
1446 $params[$fieldname] = $session->get('userID');
1448 if (CRM_Utils_Array
::value('pseudoconstant', $fieldInfo) ) {
1449 $constant = CRM_Utils_Array
::value('options', $fieldInfo);
1450 if (is_numeric($params[$fieldname]) && !CRM_Utils_Array
::value('FKClassName',$fieldInfo) && !array_key_exists($params[$fieldname], $fieldInfo['options'])) {
1451 throw new API_Exception("$fieldname is not valid", 2001, array('error_field' => $fieldname,"type"=>"integer"));
1454 // we are looking for strings that should be swapped out e.g swap 'Donation' to financial_type_id 1
1455 if (!is_numeric($params[$fieldname]) && !is_array($params[$fieldname])) {
1456 if(CRM_Utils_Array
::value('FKClassName', $fieldInfo)){
1457 // we'll get the options for this now since we are doing a swap out
1458 $options = civicrm_api($entity, 'getoptions', array('version' => 3, 'field' => $fieldname));
1459 if(empty($options['is_error'])){
1460 $fieldInfo['options'] = $options['values'];
1463 if(!empty($fieldInfo['options'])){
1464 $numericvalue = array_search($params[$fieldname], $fieldInfo['options']);
1465 if (empty($numericvalue)) {
1466 throw new Exception("$fieldname " . $params[$fieldname] . " is not valid");
1469 $params[$fieldname] = $numericvalue;
1474 // once we have done any swaps check our field length
1475 if(is_string($params[$fieldname]) &&
1476 CRM_Utils_Array
::value('maxlength',$fieldInfo)
1477 && strlen($params[$fieldname]) > $fieldInfo['maxlength']
1479 throw new API_Exception( $params[$fieldname] . " is " . strlen($params[$fieldname]) . " characters - longer than $fieldname length" . $fieldInfo['maxlength'] . ' characters',
1480 2100, array('field' => $fieldname, "max_length"=>$fieldInfo['maxlength'])
1486 function _civicrm_api3_validate_html(&$params, &$fieldname, &$fieldInfo) {
1487 if ($value = CRM_Utils_Array
::value($fieldname, $params)) {
1488 if (!CRM_Utils_Rule
::xssString($value)) {
1489 throw new API_Exception('Illegal characters in input (potential scripting attack)',array("field"=>$fieldname,"error_code"=>"xss"));
1495 * Validate string fields being passed into API.
1496 * @param array $params params from civicrm_api
1497 * @param string $fieldname uniquename of field being checked
1498 * @param array $fieldinfo array of fields from getfields function
1500 function _civicrm_api3_validate_string(&$params, &$fieldname, &$fieldInfo) {
1501 // If fieldname exists in params
1502 $value = CRM_Utils_Array
::value($fieldname, $params, '');
1503 if(!is_array($value)){
1504 $value = (string) $value;
1507 //@todo what do we do about passed in arrays. For many of these fields
1508 // the missing piece of functionality is separating them to a separated string
1509 // & many save incorrectly. But can we change them wholesale?
1512 if (!CRM_Utils_Rule
::xssString($value)) {
1513 throw new Exception('Illegal characters in input (potential scripting attack)');
1515 if ($fieldname == 'currency') {
1516 if (!CRM_Utils_Rule
::currencyCode($value)) {
1517 throw new Exception("Currency not a valid code: $value");
1520 if (!empty ($fieldInfo['options'])) {
1521 // Validate & swap out any pseudoconstants / options
1522 $options = $fieldInfo['options'];
1523 $lowerCaseOptions = array_map("strtolower", $options);
1524 // If value passed is not a key, it may be a label
1525 // Try to lookup key from label - if it can't be found throw error
1526 if (!is_array($value) && !isset($options[strtolower($value)]) && !isset($options[$value]) ) {
1527 if (!in_array(strtolower($value), $lowerCaseOptions)) {
1528 throw new Exception("$fieldname `$value` is not valid.");
1532 // Check our field length
1533 elseif (is_string($value) && !empty($fieldInfo['maxlength']) && strlen($value) > $fieldInfo['maxlength']) {
1534 throw new API_Exception("Value for $fieldname is " . strlen($value) . " characters - This field has a maxlength of {$fieldInfo['maxlength']} characters.",
1535 2100, array('field' => $fieldname)