3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM report templates.
15 * @package CiviCRM_APIv3
19 * Retrieve a report template.
21 * @param array $params
26 function civicrm_api3_report_template_get($params) {
27 require_once 'api/v3/OptionValue.php';
28 $params['option_group_id'] = CRM_Core_DAO
::getFieldValue(
29 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
31 return civicrm_api3_option_value_get($params);
37 * OptionValues are used to classify CRM entities (including Contacts, Groups and Actions).
39 * @param array $params
44 * @throws \API_Exception
46 function civicrm_api3_report_template_create($params) {
47 require_once 'api/v3/OptionValue.php';
48 $params['option_group_id'] = CRM_Core_DAO
::getFieldValue(
49 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
51 if (!empty($params['component_id']) && !is_numeric($params['component_id'])) {
52 $components = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_OptionValue', 'component_id', ['onlyActive' => FALSE, 'labelColumn' => 'name']);
53 $params['component_id'] = array_search($params['component_id'], $components);
55 return civicrm_api3_option_value_create($params);
59 * Adjust Metadata for Create action.
61 * The metadata is used for setting defaults, documentation & validation.
63 * @param array $params
64 * Array of parameters determined by getfields.
66 function _civicrm_api3_report_template_create_spec(&$params) {
67 require_once 'api/v3/OptionValue.php';
68 _civicrm_api3_option_value_create_spec($params);
69 $params['value']['api.aliases'] = ['report_url'];
70 $params['name']['api.aliases'] = ['class_name'];
71 $params['option_group_id']['api.default'] = CRM_Core_DAO
::getFieldValue(
72 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name'
74 // $params['component']['api.required'] = TRUE;
78 * Deletes an existing ReportTemplate.
80 * @param array $params
85 * @throws \API_Exception
87 function civicrm_api3_report_template_delete($params) {
88 require_once 'api/v3/OptionValue.php';
89 return civicrm_api3_option_value_delete($params);
93 * Retrieve rows from a report template.
95 * @param array $params
101 function civicrm_api3_report_template_getrows($params) {
102 civicrm_api3_verify_one_mandatory($params, NULL, ['report_id', 'instance_id']);
103 list($rows, $instance, $metadata) = _civicrm_api3_report_template_getrows($params);
104 $instance->cleanUpTemporaryTables();
105 return civicrm_api3_create_success($rows, $params, 'ReportTemplate', 'getrows', CRM_Core_DAO
::$_nullObject, $metadata);
109 * Get report template rows.
111 * @param array $params
114 * @throws API_Exception
115 * @throws CiviCRM_API3_Exception
117 function _civicrm_api3_report_template_getrows($params) {
118 if (empty($params['report_id'])) {
119 $params['report_id'] = civicrm_api3('report_instance', 'getvalue', ['id' => $params['instance_id'], 'return' => 'report_id']);
122 $class = (string) civicrm_api3('option_value', 'getvalue', [
123 'option_group_name' => 'report_template',
125 'value' => $params['report_id'],
129 /* @var \CRM_Report_Form $reportInstance */
130 $reportInstance = new $class();
131 if (!empty($params['instance_id'])) {
132 $reportInstance->setID($params['instance_id']);
134 $reportInstance->setParams($params);
135 $reportInstance->noController
= TRUE;
136 $reportInstance->preProcess();
137 $reportInstance->setDefaultValues(FALSE);
138 $reportInstance->setParams(array_merge($reportInstance->getDefaultValues(), $params));
139 $options = _civicrm_api3_get_options_from_params($params, TRUE, 'ReportTemplate', 'get');
140 $reportInstance->setLimitValue($options['limit']);
141 $reportInstance->setAddPaging(FALSE);
142 $reportInstance->setOffsetValue($options['offset']);
143 $reportInstance->beginPostProcessCommon();
144 $sql = $reportInstance->buildQuery();
145 $reportInstance->addToDeveloperTab($sql);
146 $rows = $metadata = $requiredMetadata = [];
147 $reportInstance->buildRows($sql, $rows);
148 $reportInstance->formatDisplay($rows);
150 if (isset($params['options']) && !empty($params['options']['metadata'])) {
151 $requiredMetadata = $params['options']['metadata'];
152 if (in_array('title', $requiredMetadata)) {
153 $metadata['metadata']['title'] = $reportInstance->getTitle();
155 if (in_array('labels', $requiredMetadata)) {
156 foreach ($reportInstance->_columnHeaders
as $key => $header) {
157 // Would be better just to expect reports to provide titles but reports are not consistent so we anticipate empty
158 //NB I think these are already translated
159 $metadata['metadata']['labels'][$key] = !empty($header['title']) ?
$header['title'] : '';
162 if (in_array('sql', $requiredMetadata)) {
163 $metadata['metadata']['sql'] = $reportInstance->getReportSql();
166 return [$rows, $reportInstance, $metadata];
170 * Get statistics from a given report.
172 * @param array $params
177 * @throws \API_Exception
178 * @throws \CiviCRM_API3_Exception
180 function civicrm_api3_report_template_getstatistics($params) {
181 list($rows, $reportInstance, $metadata) = _civicrm_api3_report_template_getrows($params);
182 $stats = $reportInstance->statistics($rows);
183 $reportInstance->cleanUpTemporaryTables();
184 return civicrm_api3_create_success($stats, $params, 'ReportTemplate', 'getstatistics', CRM_Core_DAO
::$_nullObject, $metadata);
188 * Adjust metadata for template getrows action.
190 * @param array $params
193 function _civicrm_api3_report_template_getrows_spec(&$params) {
194 $params['report_id'] = [
195 'title' => 'Report ID - eg. member/lapse',
199 /* @codingStandardsIgnoreStart
200 function civicrm_api3_report_template_getfields($params) {
201 return civicrm_api3_create_success(array(
207 'option_group_id' => array(
208 'name' => 'option_group_id',
211 'FKClassName' => 'CRM_Core_DAO_OptionGroup',
216 'title' => 'Option Label',
224 'title' => 'Option Value',
232 'title' => 'Option Name',
236 'where' => 'civicrm_option_value.name',
240 'name' => 'grouping',
242 'title' => 'Option Grouping Name',
251 'is_default' => array(
252 'name' => 'is_default',
261 'description' => array(
262 'name' => 'description',
264 'title' => 'Description',
268 'is_optgroup' => array(
269 'name' => 'is_optgroup',
272 'is_reserved' => array(
273 'name' => 'is_reserved',
276 'is_active' => array(
277 'name' => 'is_active',
280 'component_id' => array(
281 'name' => 'component_id',
283 'FKClassName' => 'CRM_Core_DAO_Component',
285 'domain_id' => array(
286 'name' => 'domain_id',
288 'FKClassName' => 'CRM_Core_DAO_Domain',
290 'visibility_id' => array(
291 'name' => 'visibility_id',
297 @codingStandardsIgnoreEnd */