4 * Retrieve a report template
6 * FIXME This is a bare-minimum placeholder
8 * @param array $ params input parameters
10 * {@example OptionValueGet.php 0}
11 * @example OptionValueGet.php
13 * @return array details of found Option Values
14 * {@getfields OptionValue_get}
17 function civicrm_api3_report_template_get($params) {
18 require_once 'api/v3/OptionValue.php';
19 $params['option_group_id'] = CRM_Core_DAO
::getFieldValue(
20 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
22 return civicrm_api3_option_value_get($params);
26 * Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
28 * Allowed @params array keys are:
30 * {@example OptionValueCreate.php}
32 * @return array of newly created option_value property values.
33 * {@getfields OptionValue_create}
36 function civicrm_api3_report_template_create($params) {
37 require_once 'api/v3/OptionValue.php';
38 $params['option_group_id'] = CRM_Core_DAO
::getFieldValue(
39 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
41 if (!empty($params['component_id']) && !is_numeric($params['component_id'])) {
42 $params['component_id'] = array_search($params['component_id'], CRM_Core_PseudoConstant
::component());
44 return civicrm_api3_option_value_create($params);
48 * Adjust Metadata for Create action
50 * The metadata is used for setting defaults, documentation & validation
51 * @param array $params array or parameters determined by getfields
53 function _civicrm_api3_report_template_create_spec(&$params) {
54 require_once 'api/v3/OptionValue.php';
55 _civicrm_api3_option_value_create_spec($params);
56 $params['value']['api.aliases'] = array('report_url');
57 $params['name']['api.aliases'] = array('class_name');
58 $params['option_group_id']['api.default'] = CRM_Core_DAO
::getFieldValue(
59 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
61 // $params['component']['api.required'] = TRUE;
65 * Deletes an existing ReportTemplate
67 * @param array $params
69 * {@example ReportTemplateDelete.php 0}
71 * @return array Api result
72 * {@getfields ReportTemplate_create}
75 function civicrm_api3_report_template_delete($params) {
76 require_once 'api/v3/OptionValue.php';
77 return civicrm_api3_option_value_delete($params);
81 function civicrm_api3_report_template_getfields($params) {
82 return civicrm_api3_create_success(array(
88 'option_group_id' => array(
89 'name' => 'option_group_id',
92 'FKClassName' => 'CRM_Core_DAO_OptionGroup',
97 'title' => 'Option Label',
105 'title' => 'Option Value',
113 'title' => 'Option Name',
117 'where' => 'civicrm_option_value.name',
121 'name' => 'grouping',
123 'title' => 'Option Grouping Name',
132 'is_default' => array(
133 'name' => 'is_default',
142 'description' => array(
143 'name' => 'description',
145 'title' => 'Description',
149 'is_optgroup' => array(
150 'name' => 'is_optgroup',
153 'is_reserved' => array(
154 'name' => 'is_reserved',
157 'is_active' => array(
158 'name' => 'is_active',
161 'component_id' => array(
162 'name' => 'component_id',
164 'FKClassName' => 'CRM_Core_DAO_Component',
166 'domain_id' => array(
167 'name' => 'domain_id',
169 'FKClassName' => 'CRM_Core_DAO_Domain',
171 'visibility_id' => array(
172 'name' => 'visibility_id',