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 * Retrieve rows from a report template
84 * @param array $params input parameters
86 * @return array details of found instances
89 function civicrm_api3_report_template_getrows($params) {
90 civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id'));
91 list($rows, $instance, $metadata) = _civicrm_api3_report_template_getrows($params);
92 return civicrm_api3_create_success($rows, $params, 'report_template', 'getrows', CRM_Core_DAO
::$_nullObject, $metadata);
95 function _civicrm_api3_report_template_getrows($params) {
96 if(empty($params['report_id'])) {
97 $params['report_id'] = civicrm_api3('report_instance', 'getvalue', array('id' => $params['instance_id'], 'return' => 'report_id'));
100 $class = civicrm_api3('option_value', 'getvalue', array(
101 'option_group_id' => 'report_template',
103 'value' => $params['report_id'],
107 $reportInstance = new $class();
108 if(!empty($params['instance_id'])) {
109 $reportInstance->setID($params['instance_id']);
111 $reportInstance->setParams($params);
112 $reportInstance->noController
= TRUE;
113 $reportInstance->preProcess();
114 $reportInstance->setDefaultValues(FALSE);
115 $reportInstance->setParams(array_merge($reportInstance->getDefaultValues(), $params));
116 $options = _civicrm_api3_get_options_from_params($params, TRUE,'report_template','get');
117 $reportInstance->setLimitValue($options['limit']);
118 $reportInstance->setOffsetValue($options['offset']);
119 $reportInstance->beginPostProcessCommon();
120 $sql = $reportInstance->buildQuery();
121 $rows = $metadata = $requiredMetadata = array();
122 $reportInstance->buildRows($sql, $rows);
123 $requiredMetadata = array();
124 if(isset($params['options']) && !empty($params['options']['metadata'])) {
125 $requiredMetadata = $params['options']['metadata'];
126 if(in_array('title', $requiredMetadata)) {
127 $metadata['metadata']['title'] = $reportInstance->getTitle();
129 if(in_array('labels', $requiredMetadata)) {
130 foreach ($reportInstance->_columnHeaders
as $key => $header) {
131 //would be better just to expect reports to provide titles but reports are not consistent so we anticipate empty
132 //NB I think these are already translated
133 $metadata['metadata']['labels'][$key] = !empty($header['title']) ?
$header['title'] : '';
137 return array($rows, $reportInstance, $metadata);
140 function civicrm_api3_report_template_getstatistics($params) {
141 list($rows, $reportInstance, $metadata) = _civicrm_api3_report_template_getrows($params);
142 $stats = $reportInstance->statistics($rows);
143 return civicrm_api3_create_success($stats, $params, 'report_template', 'getstatistics', CRM_Core_DAO
::$_nullObject, $metadata);
146 * Retrieve rows from a report template
148 * @param array $params input parameters
150 * @return array details of found instances
153 function _civicrm_api3_report_template_getrows_spec(&$params) {
154 $params['report_id'] = array(
155 'title' => 'Report ID - eg. member/lapse',
160 function civicrm_api3_report_template_getfields($params) {
161 return civicrm_api3_create_success(array(
167 'option_group_id' => array(
168 'name' => 'option_group_id',
171 'FKClassName' => 'CRM_Core_DAO_OptionGroup',
176 'title' => 'Option Label',
184 'title' => 'Option Value',
192 'title' => 'Option Name',
196 'where' => 'civicrm_option_value.name',
200 'name' => 'grouping',
202 'title' => 'Option Grouping Name',
211 'is_default' => array(
212 'name' => 'is_default',
221 'description' => array(
222 'name' => 'description',
224 'title' => 'Description',
228 'is_optgroup' => array(
229 'name' => 'is_optgroup',
232 'is_reserved' => array(
233 'name' => 'is_reserved',
236 'is_active' => array(
237 'name' => 'is_active',
240 'component_id' => array(
241 'name' => 'component_id',
243 'FKClassName' => 'CRM_Core_DAO_Component',
245 'domain_id' => array(
246 'name' => 'domain_id',
248 'FKClassName' => 'CRM_Core_DAO_Domain',
250 'visibility_id' => array(
251 'name' => 'visibility_id',