3 * params must contain at least id=xx & {one of the fields from getfields}=value
5 function civicrm_api3_generic_setValue($apiRequest) {
6 $entity = $apiRequest['entity'];
7 $params = $apiRequest['params'];
8 // we can't use _spec, doesn't work with generic
9 civicrm_api3_verify_mandatory($params, NULL, array('id', 'field', 'value'));
11 if (!is_numeric($id)) {
12 return civicrm_api3_create_error(ts('Please enter a number'), array('error_code' => 'NaN', 'field' => "id"));
15 $field = CRM_Utils_String
::munge($params['field']);
16 $value = $params['value'];
18 $fields = civicrm_api($entity, 'getFields', array('version' => 3, 'action' => 'create', "sequential"));
19 // getfields error, shouldn't happen.
20 if ($fields['is_error'])
22 $fields = $fields['values'];
24 if (!array_key_exists($field, $fields)) {
25 return civicrm_api3_create_error("Param 'field' ($field) is invalid. must be an existing field", array("error_code" => "invalid_field", "fields" => array_keys($fields)));
28 $def = $fields[$field];
29 if (array_key_exists('required', $def) && empty($value)) {
30 return civicrm_api3_create_error(ts("This can't be empty, please provide a value"), array("error_code" => "required", "field" => $field));
33 switch ($def['type']) {
36 if (!is_numeric($value)) {
37 return civicrm_api3_create_error("Param '$field' must be a number", array('error_code' => 'NaN'));
42 if (!CRM_Utils_Rule
::xssString($value)) {
43 return civicrm_api3_create_error(ts('Illegal characters in input (potential scripting attack)'), array('error_code' => 'XSS'));
45 if (array_key_exists('maxlength', $def)) {
46 $value = substr($value, 0, $def['maxlength']);
52 $value = CRM_Utils_Type
::escape($value,"Date",false);
54 return civicrm_api3_create_error("Param '$field' is not a date. format YYYYMMDD or YYYYMMDDHHMMSS");
59 $value = (boolean
) $value;
63 return civicrm_api3_create_error("Param '$field' is of a type not managed yet (".$def['type']."). Join the API team and help us implement it", array('error_code' => 'NOT_IMPLEMENTED'));
66 if (CRM_Core_DAO
::setFieldValue(_civicrm_api3_get_DAO($entity), $id, $field, $value)) {
67 $entity = array('id' => $id, $field => $value);
68 CRM_Utils_Hook
::post('edit', $entity, $id, $entity);
69 return civicrm_api3_create_success($entity);
72 return civicrm_api3_create_error("error assigning $field=$value for $entity (id=$id)");