| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * Retrieve custom searches. |
| 36 | * |
| 37 | * FIXME This is a bare-minimum placeholder |
| 38 | * |
| 39 | * @param array $params |
| 40 | * |
| 41 | * @return array |
| 42 | * details of found Option Values |
| 43 | */ |
| 44 | function civicrm_api3_custom_search_get($params) { |
| 45 | require_once 'api/v3/OptionValue.php'; |
| 46 | $params['option_group_id'] = CRM_Core_DAO::getFieldValue( |
| 47 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' |
| 48 | ); |
| 49 | return civicrm_api3_option_value_get($params); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Add a CustomSearch. |
| 54 | * |
| 55 | * @param array $params |
| 56 | * |
| 57 | * @return array |
| 58 | */ |
| 59 | function civicrm_api3_custom_search_create($params) { |
| 60 | require_once 'api/v3/OptionValue.php'; |
| 61 | $params['option_group_id'] = CRM_Core_DAO::getFieldValue( |
| 62 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' |
| 63 | ); |
| 64 | // empirically, class name goes to both 'name' and 'label' |
| 65 | if (array_key_exists('name', $params)) { |
| 66 | $params['label'] = $params['name']; |
| 67 | } |
| 68 | return civicrm_api3_option_value_create($params); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Adjust Metadata for Create action. |
| 73 | * |
| 74 | * The metadata is used for setting defaults, documentation & validation. |
| 75 | * |
| 76 | * @param array $params |
| 77 | * Array of parameters determined by getfields. |
| 78 | */ |
| 79 | function _civicrm_api3_custom_search_create_spec(&$params) { |
| 80 | require_once 'api/v3/OptionValue.php'; |
| 81 | _civicrm_api3_option_value_create_spec($params); |
| 82 | $params['option_group_id']['api.default'] = CRM_Core_DAO::getFieldValue( |
| 83 | 'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name' |
| 84 | ); |
| 85 | $params['name']['api.aliases'] = array('class_name'); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Deletes an existing ReportTemplate. |
| 90 | * |
| 91 | * @param array $params |
| 92 | * |
| 93 | * @return array |
| 94 | * Api result |
| 95 | */ |
| 96 | function civicrm_api3_custom_search_delete($params) { |
| 97 | require_once 'api/v3/OptionValue.php'; |
| 98 | return civicrm_api3_option_value_delete($params); |
| 99 | } |