Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
c28e1768 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
c28e1768 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
c28e1768 CW |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * This api exposes CiviCRM custom search. | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
c28e1768 | 32 | */ |
6a488035 TO |
33 | |
34 | /** | |
61fe4988 | 35 | * Retrieve custom searches. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
6a488035 | 38 | * |
a6c01b45 | 39 | * @return array |
00f8641b | 40 | * API result array |
6a488035 TO |
41 | */ |
42 | function civicrm_api3_custom_search_get($params) { | |
43 | require_once 'api/v3/OptionValue.php'; | |
44 | $params['option_group_id'] = CRM_Core_DAO::getFieldValue( | |
45 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' | |
46 | ); | |
47 | return civicrm_api3_option_value_get($params); | |
48 | } | |
49 | ||
50 | /** | |
9d32e6f7 | 51 | * Add a CustomSearch. |
6a488035 | 52 | * |
c490a46a | 53 | * @param array $params |
77b97be7 | 54 | * |
a6c01b45 | 55 | * @return array |
00f8641b | 56 | * API result array |
6a488035 TO |
57 | */ |
58 | function civicrm_api3_custom_search_create($params) { | |
59 | require_once 'api/v3/OptionValue.php'; | |
60 | $params['option_group_id'] = CRM_Core_DAO::getFieldValue( | |
61 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' | |
62 | ); | |
63 | // empirically, class name goes to both 'name' and 'label' | |
64 | if (array_key_exists('name', $params)) { | |
65 | $params['label'] = $params['name']; | |
66 | } | |
67 | return civicrm_api3_option_value_create($params); | |
68 | } | |
69 | ||
11e09c59 | 70 | /** |
0aa0303c EM |
71 | * Adjust Metadata for Create action. |
72 | * | |
73 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 74 | * |
cf470720 | 75 | * @param array $params |
b081365f | 76 | * Array of parameters determined by getfields. |
6a488035 TO |
77 | */ |
78 | function _civicrm_api3_custom_search_create_spec(&$params) { | |
79 | require_once 'api/v3/OptionValue.php'; | |
80 | _civicrm_api3_option_value_create_spec($params); | |
e310e129 C |
81 | $params['option_group_id']['api.default'] = CRM_Core_DAO::getFieldValue( |
82 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' | |
83 | ); | |
6a488035 TO |
84 | $params['name']['api.aliases'] = array('class_name'); |
85 | } | |
86 | ||
87 | /** | |
00f8641b | 88 | * Deletes an existing CustomSearch. |
6a488035 | 89 | * |
cf470720 | 90 | * @param array $params |
6a488035 | 91 | * |
a6c01b45 | 92 | * @return array |
00f8641b | 93 | * API result array |
6a488035 TO |
94 | */ |
95 | function civicrm_api3_custom_search_delete($params) { | |
96 | require_once 'api/v3/OptionValue.php'; | |
97 | return civicrm_api3_option_value_delete($params); | |
98 | } |