Commit | Line | Data |
---|---|---|
0b25329b | 1 | <?php |
c28e1768 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
c28e1768 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
c28e1768 CW |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * This api exposes CiviCRM report instances. | |
30 | * | |
b081365f | 31 | * @package CiviCRM_APIv3 |
c28e1768 | 32 | */ |
0b25329b DS |
33 | |
34 | /** | |
9d32e6f7 | 35 | * Retrieve a report instance. |
0b25329b | 36 | * |
cf470720 TO |
37 | * @param array $params |
38 | * Input parameters. | |
0b25329b | 39 | * |
a6c01b45 | 40 | * @return array |
00f8641b | 41 | * API result array |
0b25329b DS |
42 | */ |
43 | function civicrm_api3_report_instance_get($params) { | |
44 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
45 | } | |
46 | ||
47 | /** | |
9d32e6f7 | 48 | * Add or update a report instance. |
77b97be7 | 49 | * |
c490a46a | 50 | * @param array $params |
0b25329b | 51 | * |
a6c01b45 | 52 | * @return array |
00f8641b | 53 | * API result array |
0b25329b DS |
54 | */ |
55 | function civicrm_api3_report_instance_create($params) { | |
56 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
57 | } | |
58 | ||
59 | /** | |
0aa0303c EM |
60 | * Adjust Metadata for Create action. |
61 | * | |
62 | * The metadata is used for setting defaults, documentation & validation. | |
0b25329b | 63 | * |
cf470720 | 64 | * @param array $params |
b081365f | 65 | * Array of parameters determined by getfields. |
0b25329b DS |
66 | */ |
67 | function _civicrm_api3_report_instance_create_spec(&$params) { | |
68 | $params['report_id']['api.required'] = 1; | |
69 | $params['title']['api.required'] = 1; | |
e6e7e540 | 70 | $params['view_mode']['api.default'] = 'view'; |
71 | $params['view_mode']['title'] = ts('View Mode for Navigation URL'); | |
72 | $params['view_mode']['type'] = CRM_Utils_Type::T_STRING; | |
73 | $params['view_mode']['options'] = array( | |
74 | 'view' => ts('View'), | |
75 | 'criteria' => ts('Show Criteria'), | |
76 | ); | |
0b25329b DS |
77 | } |
78 | ||
79 | /** | |
dc64d047 | 80 | * Deletes an existing ReportInstance. |
0b25329b | 81 | * |
cf470720 | 82 | * @param array $params |
0b25329b | 83 | * |
a6c01b45 | 84 | * @return array |
00f8641b | 85 | * API result array |
0b25329b DS |
86 | */ |
87 | function civicrm_api3_report_instance_delete($params) { | |
88 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
89 | } |