drupal-civicrm/sites/all/modules/civicrm/api/v3/CustomSearch.php
2018-01-14 13:10:16 +00:00

99 lines
3.4 KiB
PHP

<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* This api exposes CiviCRM custom search.
*
* @package CiviCRM_APIv3
*/
/**
* Retrieve custom searches.
*
* @param array $params
*
* @return array
* API result array
*/
function civicrm_api3_custom_search_get($params) {
require_once 'api/v3/OptionValue.php';
$params['option_group_id'] = CRM_Core_DAO::getFieldValue(
'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name'
);
return civicrm_api3_option_value_get($params);
}
/**
* Add a CustomSearch.
*
* @param array $params
*
* @return array
* API result array
*/
function civicrm_api3_custom_search_create($params) {
require_once 'api/v3/OptionValue.php';
$params['option_group_id'] = CRM_Core_DAO::getFieldValue(
'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name'
);
// empirically, class name goes to both 'name' and 'label'
if (array_key_exists('name', $params)) {
$params['label'] = $params['name'];
}
return civicrm_api3_option_value_create($params);
}
/**
* Adjust Metadata for Create action.
*
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
* Array of parameters determined by getfields.
*/
function _civicrm_api3_custom_search_create_spec(&$params) {
require_once 'api/v3/OptionValue.php';
_civicrm_api3_option_value_create_spec($params);
$params['option_group_id']['api.default'] = CRM_Core_DAO::getFieldValue(
'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name'
);
$params['name']['api.aliases'] = array('class_name');
}
/**
* Deletes an existing CustomSearch.
*
* @param array $params
*
* @return array
* API result array
*/
function civicrm_api3_custom_search_delete($params) {
require_once 'api/v3/OptionValue.php';
return civicrm_api3_option_value_delete($params);
}