4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Generic api wrapper used for quicksearch and autocomplete
31 * @param $apiRequest array
34 function civicrm_api3_generic_getList($apiRequest) {
35 $entity = _civicrm_api_get_entity_name_from_camel($apiRequest['entity']);
36 $request = $apiRequest['params'];
38 _civicrm_api3_generic_getList_defaults($entity, $request);
40 // Hey api, would you like to format the search params?
41 $fnName = "_civicrm_api3_{$entity}_getlist_params";
42 $fnName = function_exists($fnName) ?
$fnName : '_civicrm_api3_generic_getlist_params';
45 $request['params']['check_permissions'] = !empty($apiRequest['params']['check_permissions']);
46 $result = civicrm_api3($entity, 'get', $request['params']);
48 // Hey api, would you like to format the output?
49 $fnName = "_civicrm_api3_{$entity}_getlist_output";
50 $fnName = function_exists($fnName) ?
$fnName : '_civicrm_api3_generic_getlist_output';
51 $values = $fnName($result, $request);
54 // If we have an extra result then this is not the last page
55 'more_results' => isset($values[10]),
56 'page_num' => $request['page_num'],
60 return civicrm_api3_create_success($values, $request['params'], $entity, 'getlist', CRM_Core_DAO
::$_nullObject, $output);
64 * Set defaults for api.getlist
66 * @param $entity string
67 * @param $request array
69 function _civicrm_api3_generic_getList_defaults($entity, &$request) {
70 $config = CRM_Core_Config
::singleton();
71 $fields = _civicrm_api_get_fields($entity);
75 'image_field' => NULL,
76 'id_field' => $entity == 'option_value' ?
'value' : 'id',
77 'description_field' => array(),
81 // Find main field from meta
82 foreach (array('sort_name', 'title', 'label', 'name') as $field) {
83 if (isset($fields[$field])) {
84 $defaults['label_field'] = $defaults['search_field'] = $field;
88 // Find fields to be used for the description
89 foreach (array('description') as $field) {
90 if (isset($fields[$field])) {
91 $defaults['description_field'][] = $field;
94 $resultsPerPage = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'search_autocomplete_count', NULL, 10);
95 $request +
= $defaults;
99 // Adding one extra result allows us to see if there are any more
100 'limit' => $resultsPerPage +
1,
101 // Because sql is zero-based
102 'offset' => ($request['page_num'] - 1) * $resultsPerPage,
103 'sort' => $request['label_field'],
107 // When searching e.g. autocomplete
108 if ($request['input']) {
109 $params[$request['search_field']] = array('LIKE' => ($config->includeWildCardInName ?
'%' : '') . $request['input'] . '%');
111 // When looking up a field e.g. displaying existing record
112 if (!empty($request['id'])) {
113 if (is_string($request['id']) && strpos(',', $request['id'])) {
114 $request['id'] = explode(',', $request['id']);
116 $params[$request['id_field']] = is_array($request['id']) ?
array('IN' => $request['id']) : $request['id'];
118 $request['params'] +
= $params;
122 * Fallback implementation of getlist_params. May be overridden by individual apis
124 * @param $request array
126 function _civicrm_api3_generic_getlist_params(&$request) {
127 $fieldsToReturn = array($request['id_field'], $request['label_field']);
128 if (!empty($request['image_field'])) {
129 $fieldsToReturn[] = $request['image_field'];
131 if (!empty($request['description_field'])) {
132 $fieldsToReturn = array_merge($fieldsToReturn, (array) $request['description_field']);
134 $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
138 * Fallback implementation of getlist_output. May be overridden by individual apis
140 * @param $result array
141 * @param $request array
145 function _civicrm_api3_generic_getlist_output($result, $request) {
147 if (!empty($result['values'])) {
148 foreach ($result['values'] as $row) {
150 'id' => $row[$request['id_field']],
151 'label' => $row[$request['label_field']],
153 if (!empty($request['description_field'])) {
154 $data['description'] = array();
155 foreach ((array) $request['description_field'] as $field) {
156 if (!empty($row[$field])) {
157 $data['description'][] = $row[$field];
161 if (!empty($request['image_field'])) {
162 $data['image'] = isset($row[$request['image_field']]) ?
$row[$request['image_field']] : '';
164 foreach ($request['extra'] as $field) {
165 $data['extra'][$field] = isset($row[$field]) ?
$row[$field] : NULL;