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 $components = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_OptionValue', 'component_id', array('onlyActive' => FALSE, 'labelColumn' => 'name'));
43 $params['component_id'] = array_search($params['component_id'], $components);
45 return civicrm_api3_option_value_create($params);
49 * Adjust Metadata for Create action
51 * The metadata is used for setting defaults, documentation & validation
52 * @param array $params array or parameters determined by getfields
54 function _civicrm_api3_report_template_create_spec(&$params) {
55 require_once 'api/v3/OptionValue.php';
56 _civicrm_api3_option_value_create_spec($params);
57 $params['value']['api.aliases'] = array('report_url');
58 $params['name']['api.aliases'] = array('class_name');
59 $params['option_group_id']['api.default'] = CRM_Core_DAO
::getFieldValue(
60 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
62 // $params['component']['api.required'] = TRUE;
66 * Deletes an existing ReportTemplate
68 * @param array $params
70 * {@example ReportTemplateDelete.php 0}
72 * @return array Api result
73 * {@getfields ReportTemplate_create}
76 function civicrm_api3_report_template_delete($params) {
77 require_once 'api/v3/OptionValue.php';
78 return civicrm_api3_option_value_delete($params);
82 function civicrm_api3_report_template_getfields($params) {
83 return civicrm_api3_create_success(array(
89 'option_group_id' => array(
90 'name' => 'option_group_id',
93 'FKClassName' => 'CRM_Core_DAO_OptionGroup',
98 'title' => 'Option Label',
106 'title' => 'Option Value',
114 'title' => 'Option Name',
118 'where' => 'civicrm_option_value.name',
122 'name' => 'grouping',
124 'title' => 'Option Grouping Name',
133 'is_default' => array(
134 'name' => 'is_default',
143 'description' => array(
144 'name' => 'description',
146 'title' => 'Description',
150 'is_optgroup' => array(
151 'name' => 'is_optgroup',
154 'is_reserved' => array(
155 'name' => 'is_reserved',
158 'is_active' => array(
159 'name' => 'is_active',
162 'component_id' => array(
163 'name' => 'component_id',
165 'FKClassName' => 'CRM_Core_DAO_Component',
167 'domain_id' => array(
168 'name' => 'domain_id',
170 'FKClassName' => 'CRM_Core_DAO_Domain',
172 'visibility_id' => array(
173 'name' => 'visibility_id',