| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.3 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 12 | | under the terms of the GNU Affero General Public License | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 14 | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 18 | | See the GNU Affero General Public License for more details. | |
| 19 | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | |
| 21 | | License and the CiviCRM Licensing Exception along | |
| 22 | | with this program; if not, contact CiviCRM LLC | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 26 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * File for the CiviCRM APIv3 custom value functions |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_CustomField |
| 34 | * |
| 35 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 36 | * @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $ |
| 37 | */ |
| 38 | |
| 39 | /** |
| 40 | * Files required for this package |
| 41 | */ |
| 42 | |
| 43 | |
| 44 | /** |
| 45 | * Sets custom values for an entity. |
| 46 | * |
| 47 | * |
| 48 | * @param $params expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID |
| 49 | * for example: |
| 50 | // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using |
| 51 | * 'entity_id' => 123, |
| 52 | // (omitting :id) inserts or updates a field in a single-valued group |
| 53 | * 'custom_6' => 'foo', |
| 54 | // custom_24 is checkbox or multiselect, so pass items as an array |
| 55 | * 'custom_24' => array('bar', 'baz'), |
| 56 | // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 |
| 57 | * 'custom_33:5' => value, |
| 58 | // inserts new record in multi-valued group |
| 59 | * 'custom_33:-1' => value, |
| 60 | // inserts another new record in multi-valued group |
| 61 | * 'custom_33:-2' => value, |
| 62 | // you can use group_name:field_name instead of ID |
| 63 | * 'custom_some_group:my_field => 'myinfo', |
| 64 | // updates record ID 8 in my_other_field in multi-valued some_big_group |
| 65 | * 'custom_some_big_group:my_other_field:8 => 'myinfo', |
| 66 | * |
| 67 | * |
| 68 | * @return array('values' => TRUE) or array('is_error' => 1, 'error_message' => 'what went wrong') |
| 69 | * |
| 70 | * @access public |
| 71 | * |
| 72 | */ |
| 73 | function civicrm_api3_custom_value_create($params) { |
| 74 | // @todo it's not clear where the entity_table is used as CRM_Core_BAO_CustomValueTable::setValues($create) |
| 75 | // didn't seem to use it |
| 76 | // so not clear if it's relevant |
| 77 | if (!empty($params['entity_table']) && substr($params['entity_table'], 0, 7) == 'civicrm') { |
| 78 | $params['entity_table'] = substr($params['entity_table'], 8, 7); |
| 79 | } |
| 80 | $create = array('entityID' => $params['entity_id']); |
| 81 | // Translate names and |
| 82 | //Convert arrays to multi-value strings |
| 83 | $sp = CRM_Core_DAO::VALUE_SEPARATOR; |
| 84 | foreach ($params as $id => $param) { |
| 85 | if (is_array($param)) { |
| 86 | $param = $sp . implode($sp, $param) . $sp; |
| 87 | } |
| 88 | list($c, $id) = CRM_Utils_System::explode('_', $id, 2); |
| 89 | if ($c != 'custom') { |
| 90 | continue; |
| 91 | } |
| 92 | list($i, $n, $x) = CRM_Utils_System::explode(':', $id, 3); |
| 93 | if (is_numeric($i)) { |
| 94 | $key = $i; |
| 95 | $x = $n; |
| 96 | } |
| 97 | else { |
| 98 | // Lookup names if ID was not supplied |
| 99 | $key = CRM_Core_BAO_CustomField::getCustomFieldID($n, $i); |
| 100 | if (!$key) { |
| 101 | continue; |
| 102 | } |
| 103 | } |
| 104 | if ($x && is_numeric($x)) { |
| 105 | $key .= '_' . $x; |
| 106 | } |
| 107 | $create['custom_' . $key] = $param; |
| 108 | } |
| 109 | $result = CRM_Core_BAO_CustomValueTable::setValues($create); |
| 110 | if ($result['is_error']) { |
| 111 | throw new Exception($result['error_message']); |
| 112 | } |
| 113 | return civicrm_api3_create_success(TRUE, $params); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Adjust Metadata for Create action |
| 118 | * |
| 119 | * The metadata is used for setting defaults, documentation & validation |
| 120 | * @param array $params array or parameters determined by getfields |
| 121 | */ |
| 122 | function _civicrm_api3_custom_value_create_spec(&$params) { |
| 123 | $params['entity_id']['api.required'] = 1; |
| 124 | } |
| 125 | /** |
| 126 | * Use this API to get existing custom values for an entity. |
| 127 | * |
| 128 | * @param $params array specifying the entity_id |
| 129 | * Optionally include entity_type param, i.e. 'entity_type' => 'Activity' |
| 130 | * If no entity_type is supplied, it will be determined based on the fields you request. |
| 131 | * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed. |
| 132 | * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned) |
| 133 | * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 |
| 134 | * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 |
| 135 | * |
| 136 | * @return array. |
| 137 | * |
| 138 | * @access public |
| 139 | */ |
| 140 | function civicrm_api3_custom_value_get($params) { |
| 141 | |
| 142 | $getParams = array( |
| 143 | 'entityID' => $params['entity_id'], |
| 144 | 'entityType' => CRM_Utils_Array::value('entity_table', $params, ''), |
| 145 | ); |
| 146 | if (strstr($getParams['entityType'], 'civicrm_')) { |
| 147 | $getParams['entityType'] = ucfirst(substr($getParams['entityType'], 8)); |
| 148 | } |
| 149 | unset($params['entity_id'], $params['entity_table']); |
| 150 | foreach ($params as $id => $param) { |
| 151 | if ($param && substr($id, 0, 6) == 'return') { |
| 152 | $id = substr($id, 7); |
| 153 | list($c, $i) = CRM_Utils_System::explode('_', $id, 2); |
| 154 | if ($c == 'custom' && is_numeric($i)) { |
| 155 | $names['custom_' . $i] = 'custom_' . $i; |
| 156 | $id = $i; |
| 157 | } |
| 158 | else { |
| 159 | // Lookup names if ID was not supplied |
| 160 | list($group, $field) = CRM_Utils_System::explode(':', $id, 2); |
| 161 | $id = CRM_Core_BAO_CustomField::getCustomFieldID($field, $group); |
| 162 | if (!$id) { |
| 163 | continue; |
| 164 | } |
| 165 | $names['custom_' . $id] = 'custom_' . $i; |
| 166 | } |
| 167 | $getParams['custom_' . $id] = 1; |
| 168 | } |
| 169 | } |
| 170 | |
| 171 | $result = CRM_Core_BAO_CustomValueTable::getValues($getParams); |
| 172 | |
| 173 | if ($result['is_error']) { |
| 174 | if ($result['error_message'] == "No values found for the specified entity ID and custom field(s).") { |
| 175 | $values = array(); |
| 176 | return civicrm_api3_create_success($values, $params); |
| 177 | } |
| 178 | else { |
| 179 | return civicrm_api3_create_error($result['error_message']); |
| 180 | } |
| 181 | } |
| 182 | else { |
| 183 | $entity_id = $result['entityID']; |
| 184 | unset($result['is_error'], $result['entityID']); |
| 185 | // Convert multi-value strings to arrays |
| 186 | $sp = CRM_Core_DAO::VALUE_SEPARATOR; |
| 187 | foreach ($result as $id => $value) { |
| 188 | if (strpos($value, $sp) !== FALSE) { |
| 189 | $value = explode($sp, trim($value, $sp)); |
| 190 | } |
| 191 | |
| 192 | $idArray = explode('_', $id); |
| 193 | if ($idArray[0] != 'custom') { |
| 194 | continue; |
| 195 | } |
| 196 | $fieldNumber = $idArray[1]; |
| 197 | $info = array_pop(CRM_Core_BAO_CustomField::getNameFromID($fieldNumber)); |
| 198 | // id is the index for returned results |
| 199 | |
| 200 | if (empty($idArray[2])) { |
| 201 | $n = 0; |
| 202 | $id = $fieldNumber; |
| 203 | } |
| 204 | else{ |
| 205 | $n = $idArray[2]; |
| 206 | $id = $fieldNumber . "." . $idArray[2]; |
| 207 | } |
| 208 | if (CRM_Utils_Array::value('format.field_names', $params)) { |
| 209 | $id = $info['field_name']; |
| 210 | } |
| 211 | else { |
| 212 | $id = $fieldNumber; |
| 213 | } |
| 214 | $values[$id]['entity_id'] = $getParams['entityID']; |
| 215 | if (CRM_Utils_Array::value('entityType', $getParams)) { |
| 216 | $values[$n]['entity_table'] = $getParams['entityType']; |
| 217 | } |
| 218 | //set 'latest' -useful for multi fields but set for single for consistency |
| 219 | $values[$id]['latest'] = $value; |
| 220 | $values[$id]['id'] = $id; |
| 221 | $values[$id][$n] = $value; |
| 222 | } |
| 223 | return civicrm_api3_create_success($values, $params); |
| 224 | } |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Adjust Metadata for Get action |
| 229 | * |
| 230 | * The metadata is used for setting defaults, documentation & validation |
| 231 | * @param array $params array or parameters determined by getfields |
| 232 | */ |
| 233 | function _civicrm_api3_custom_value_get_spec(&$params) { |
| 234 | $params['entity_id']['api.required'] = 1; |
| 235 | } |