Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | ||
3 | /** | |
4 | * Retrieve a report template | |
5 | * | |
6 | * FIXME This is a bare-minimum placeholder | |
7 | * | |
8 | * @param array $ params input parameters | |
9 | * | |
10 | * {@example OptionValueGet.php 0} | |
11 | * @example OptionValueGet.php | |
12 | * | |
13 | * @return array details of found Option Values | |
14 | * {@getfields OptionValue_get} | |
15 | * @access public | |
16 | */ | |
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' | |
21 | ); | |
22 | return civicrm_api3_option_value_get($params); | |
23 | } | |
24 | ||
25 | /** | |
26 | * Add a OptionValue. OptionValues are used to classify CRM entities (including Contacts, Groups and Actions). | |
27 | * | |
28 | * Allowed @params array keys are: | |
29 | * | |
30 | * {@example OptionValueCreate.php} | |
31 | * | |
32 | * @return array of newly created option_value property values. | |
33 | * {@getfields OptionValue_create} | |
34 | * @access public | |
35 | */ | |
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' | |
40 | ); | |
1cbea43e | 41 | if (!empty($params['component_id']) && !is_numeric($params['component_id'])) { |
8f785c9e AS |
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); | |
1cbea43e | 44 | } |
6a488035 TO |
45 | return civicrm_api3_option_value_create($params); |
46 | } | |
47 | ||
11e09c59 | 48 | /** |
6a488035 TO |
49 | * Adjust Metadata for Create action |
50 | * | |
51 | * The metadata is used for setting defaults, documentation & validation | |
52 | * @param array $params array or parameters determined by getfields | |
53 | */ | |
54 | function _civicrm_api3_report_template_create_spec(&$params) { | |
55 | require_once 'api/v3/OptionValue.php'; | |
56 | _civicrm_api3_option_value_create_spec($params); | |
6a488035 TO |
57 | $params['value']['api.aliases'] = array('report_url'); |
58 | $params['name']['api.aliases'] = array('class_name'); | |
1cbea43e C |
59 | $params['option_group_id']['api.default'] = CRM_Core_DAO::getFieldValue( |
60 | 'CRM_Core_DAO_OptionGroup', 'report_template', 'id', 'name' | |
61 | ); | |
6a488035 TO |
62 | // $params['component']['api.required'] = TRUE; |
63 | } | |
64 | ||
65 | /** | |
66 | * Deletes an existing ReportTemplate | |
67 | * | |
68 | * @param array $params | |
69 | * | |
70 | * {@example ReportTemplateDelete.php 0} | |
71 | * | |
72 | * @return array Api result | |
73 | * {@getfields ReportTemplate_create} | |
74 | * @access public | |
75 | */ | |
76 | function civicrm_api3_report_template_delete($params) { | |
77 | require_once 'api/v3/OptionValue.php'; | |
78 | return civicrm_api3_option_value_delete($params); | |
79 | } | |
80 | ||
c58f66e0 E |
81 | /** |
82 | * Retrieve rows from a report template | |
83 | * | |
84 | * @param array $params input parameters | |
85 | * | |
86 | * @return array details of found instances | |
87 | * @access public | |
88 | */ | |
89 | function civicrm_api3_report_template_getrows($params) { | |
05274f12 | 90 | civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id')); |
781d91c8 EM |
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); | |
c58f66e0 E |
93 | } |
94 | ||
95 | function _civicrm_api3_report_template_getrows($params) { | |
05274f12 E |
96 | if(empty($params['report_id'])) { |
97 | $params['report_id'] = civicrm_api3('report_instance', 'getvalue', array('id' => $params['instance_id'], 'return' => 'report_id')); | |
98 | } | |
99 | ||
c58f66e0 | 100 | $class = civicrm_api3('option_value', 'getvalue', array( |
6f900755 E |
101 | 'option_group_id' => 'report_template', |
102 | 'return' => 'name', | |
103 | 'value' => $params['report_id'], | |
104 | ) | |
c58f66e0 E |
105 | ); |
106 | ||
107 | $reportInstance = new $class(); | |
108 | if(!empty($params['instance_id'])) { | |
109 | $reportInstance->setID($params['instance_id']); | |
110 | } | |
111 | $reportInstance->setParams($params); | |
112 | $reportInstance->noController = TRUE; | |
113 | $reportInstance->preProcess(); | |
114 | $reportInstance->setDefaultValues(FALSE); | |
115 | $reportInstance->setParams(array_merge($reportInstance->getDefaultValues(), $params)); | |
6f900755 E |
116 | $options = _civicrm_api3_get_options_from_params($params, TRUE,'report_template','get'); |
117 | $reportInstance->setLimitValue($options['limit']); | |
118 | $reportInstance->setOffsetValue($options['offset']); | |
c58f66e0 E |
119 | $reportInstance->beginPostProcessCommon(); |
120 | $sql = $reportInstance->buildQuery(); | |
781d91c8 | 121 | $rows = $metadata = $requiredMetadata = array(); |
c58f66e0 | 122 | $reportInstance->buildRows($sql, $rows); |
781d91c8 EM |
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(); | |
128 | } | |
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'] : ''; | |
134 | } | |
135 | } | |
7cab1323 EM |
136 | } |
137 | return array($rows, $reportInstance, $metadata); | |
c58f66e0 E |
138 | } |
139 | ||
140 | function civicrm_api3_report_template_getstatistics($params) { | |
781d91c8 | 141 | list($rows, $reportInstance, $metadata) = _civicrm_api3_report_template_getrows($params); |
c58f66e0 | 142 | $stats = $reportInstance->statistics($rows); |
781d91c8 | 143 | return civicrm_api3_create_success($stats, $params, 'report_template', 'getstatistics', CRM_Core_DAO::$_nullObject, $metadata); |
c58f66e0 E |
144 | } |
145 | /** | |
146 | * Retrieve rows from a report template | |
147 | * | |
148 | * @param array $params input parameters | |
149 | * | |
150 | * @return array details of found instances | |
151 | * @access public | |
152 | */ | |
153 | function _civicrm_api3_report_template_getrows_spec(&$params) { | |
154 | $params['report_id'] = array( | |
c58f66e0 E |
155 | 'title' => 'Report ID - eg. member/lapse', |
156 | ); | |
157 | } | |
158 | ||
6a488035 TO |
159 | /* |
160 | function civicrm_api3_report_template_getfields($params) { | |
161 | return civicrm_api3_create_success(array( | |
162 | 'id' => array( | |
163 | 'name' => 'id', | |
164 | 'type' => 1, | |
165 | 'required' => 1, | |
166 | ), | |
167 | 'option_group_id' => array( | |
168 | 'name' => 'option_group_id', | |
169 | 'type' => 1, | |
170 | 'required' => 1, | |
171 | 'FKClassName' => 'CRM_Core_DAO_OptionGroup', | |
172 | ), | |
173 | 'label' => array( | |
174 | 'name' => 'label', | |
175 | 'type' => 2, | |
176 | 'title' => 'Option Label', | |
177 | 'required' => 1, | |
178 | 'maxlength' => 255, | |
179 | 'size' => 45, | |
180 | ), | |
181 | 'value' => array( | |
182 | 'name' => 'value', | |
183 | 'type' => 2, | |
184 | 'title' => 'Option Value', | |
185 | 'required' => 1, | |
186 | 'maxlength' => 512, | |
187 | 'size' => 45, | |
188 | ), | |
189 | 'name' => array( | |
190 | 'name' => 'name', | |
191 | 'type' => 2, | |
192 | 'title' => 'Option Name', | |
193 | 'maxlength' => 255, | |
194 | 'size' => 45, | |
195 | 'import' => 1, | |
196 | 'where' => 'civicrm_option_value.name', | |
197 | 'export' => 1, | |
198 | ), | |
199 | 'grouping' => array( | |
200 | 'name' => 'grouping', | |
201 | 'type' => 2, | |
202 | 'title' => 'Option Grouping Name', | |
203 | 'maxlength' => 255, | |
204 | 'size' => 45, | |
205 | ), | |
206 | 'filter' => array( | |
207 | 'name' => 'filter', | |
208 | 'type' => 1, | |
209 | 'title' => 'Filter', | |
210 | ), | |
211 | 'is_default' => array( | |
212 | 'name' => 'is_default', | |
213 | 'type' => 16, | |
214 | ), | |
215 | 'weight' => array( | |
216 | 'name' => 'weight', | |
217 | 'type' => 1, | |
218 | 'title' => 'Weight', | |
219 | 'required' => 1, | |
220 | ), | |
221 | 'description' => array( | |
222 | 'name' => 'description', | |
223 | 'type' => 32, | |
224 | 'title' => 'Description', | |
225 | 'rows' => 8, | |
226 | 'cols' => 60, | |
227 | ), | |
228 | 'is_optgroup' => array( | |
229 | 'name' => 'is_optgroup', | |
230 | 'type' => 16, | |
231 | ), | |
232 | 'is_reserved' => array( | |
233 | 'name' => 'is_reserved', | |
234 | 'type' => 16, | |
235 | ), | |
236 | 'is_active' => array( | |
237 | 'name' => 'is_active', | |
238 | 'type' => 16, | |
239 | ), | |
240 | 'component_id' => array( | |
241 | 'name' => 'component_id', | |
242 | 'type' => 1, | |
243 | 'FKClassName' => 'CRM_Core_DAO_Component', | |
244 | ), | |
245 | 'domain_id' => array( | |
246 | 'name' => 'domain_id', | |
247 | 'type' => 1, | |
248 | 'FKClassName' => 'CRM_Core_DAO_Domain', | |
249 | ), | |
250 | 'visibility_id' => array( | |
251 | 'name' => 'visibility_id', | |
252 | 'type' => 1, | |
253 | 'default' => 'UL', | |
254 | ), | |
255 | )); | |
256 | }*/ |