api/v3/CustomSearch.php

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