api/v3/CustomSearch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM custom search.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Retrieve custom searches.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  *   API result array
  25  */
  26 function civicrm_api3_custom_search_get($params) {
  27   require_once 'api/v3/OptionValue.php';
  28   $params['option_group_id'] = CRM_Core_DAO::getFieldValue(
  29     'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name'
  30   );
  31   return civicrm_api3_option_value_get($params);
  32 }
  33
  34 /**
  35  * Add a CustomSearch.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function civicrm_api3_custom_search_create($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   // empirically, class name goes to both 'name' and 'label'
  48   if (array_key_exists('name', $params)) {
  49     $params['label'] = $params['name'];
  50   }
  51   return civicrm_api3_option_value_create($params);
  52 }
  53
  54 /**
  55  * Adjust Metadata for Create action.
  56  *
  57  * The metadata is used for setting defaults, documentation & validation.
  58  *
  59  * @param array $params
  60  *   Array of parameters determined by getfields.
  61  */
  62 function _civicrm_api3_custom_search_create_spec(&$params) {
  63   require_once 'api/v3/OptionValue.php';
  64   _civicrm_api3_option_value_create_spec($params);
  65   $params['option_group_id']['api.default'] = CRM_Core_DAO::getFieldValue(
  66     'CRM_Core_DAO_OptionGroup', 'custom_search', 'id', 'name'
  67   );
  68   $params['name']['api.aliases'] = ['class_name'];
  69 }
  70
  71 /**
  72  * Deletes an existing CustomSearch.
  73  *
  74  * @param array $params
  75  *
  76  * @return array
  77  *   API result array
  78  */
  79 function civicrm_api3_custom_search_delete($params) {
  80   require_once 'api/v3/OptionValue.php';
  81   return civicrm_api3_option_value_delete($params);
  82 }