3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
33 class CRM_Report_BAO_ReportInstance
extends CRM_Report_DAO_ReportInstance
{
36 * Takes an associative array and creates an instance object.
38 * the function extract all the params it needs to initialize the create a
39 * instance object. the params array could contain additional unused name/value
42 * @param array $params
43 * (reference ) an assoc array of name/value pairs.
45 * @return CRM_Report_DAO_ReportInstance
47 public static function add(&$params) {
48 $instance = new CRM_Report_DAO_ReportInstance();
53 $instanceID = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('instance_id', $params));
55 // convert roles array to string
56 if (isset($params['grouprole']) && is_array($params['grouprole'])) {
57 $grouprole_array = array();
58 foreach ($params['grouprole'] as $key => $value) {
59 $grouprole_array[$value] = $value;
61 $params['grouprole'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
62 array_keys($grouprole_array)
66 if (!$instanceID ||
!isset($params['id'])) {
67 $params['is_reserved'] = CRM_Utils_Array
::value('is_reserved', $params, FALSE);
68 $params['domain_id'] = CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
69 // CRM-17256 set created_id on report creation.
70 $params['created_id'] = isset($params['created_id']) ?
$params['created_id'] : CRM_Core_Session
::getLoggedInContactID();
74 CRM_Utils_Hook
::pre('edit', 'ReportInstance', $instanceID, $params);
77 CRM_Utils_Hook
::pre('create', 'ReportInstance', NULL, $params);
80 $instance = new CRM_Report_DAO_ReportInstance();
81 $instance->copyValues($params);
83 if (CRM_Core_Config
::singleton()->userFramework
== 'Joomla') {
84 $instance->permission
= 'null';
87 // explicitly set to null if params value is empty
88 if (!$instanceID && empty($params['grouprole'])) {
89 $instance->grouprole
= 'null';
93 $instance->id
= $instanceID;
97 if ($reportID = CRM_Utils_Array
::value('report_id', $params)) {
98 $instance->report_id
= $reportID;
100 elseif ($instanceID) {
101 $instance->report_id
= CRM_Report_Utils_Report
::getValueFromUrl($instanceID);
104 // just take it from current url
105 $instance->report_id
= CRM_Report_Utils_Report
::getValueFromUrl();
112 CRM_Utils_Hook
::pre('edit', 'ReportInstance', $instance->id
, $instance);
115 CRM_Utils_Hook
::pre('create', 'ReportInstance', $instance->id
, $instance);
123 * takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc.
125 * This function is invoked from within the web form layer and also from the api layer
127 * @param array $params
128 * (reference ) an assoc array of name/value pairs.
130 * @return CRM_Report_BAO_ReportInstance
132 public static function &create(&$params) {
133 if (isset($params['report_header'])) {
134 $params['header'] = CRM_Utils_Array
::value('report_header', $params);
136 if (isset($params['report_footer'])) {
137 $params['footer'] = CRM_Utils_Array
::value('report_footer', $params);
140 // build navigation parameters
141 if (!empty($params['is_navigation'])) {
142 if (!array_key_exists('navigation', $params)) {
143 $params['navigation'] = array();
145 $navigationParams =& $params['navigation'];
147 $navigationParams['permission'] = array();
148 $navigationParams['label'] = $params['title'];
149 $navigationParams['name'] = $params['title'];
151 $navigationParams['current_parent_id'] = CRM_Utils_Array
::value('parent_id', $navigationParams);
152 $navigationParams['parent_id'] = CRM_Utils_Array
::value('parent_id', $params);
153 $navigationParams['is_active'] = 1;
155 if ($permission = CRM_Utils_Array
::value('permission', $params)) {
156 $navigationParams['permission'][] = $permission;
159 // unset the navigation related elements, not used in report form values
160 unset($params['parent_id']);
161 unset($params['is_navigation']);
164 $viewMode = !empty($params['view_mode']) ?
$params['view_mode'] : FALSE;
166 // Do not save to the DB - it's saved in the url.
167 unset($params['view_mode']);
171 $dashletParams = array();
172 if (!empty($params['addToDashboard'])) {
173 $dashletParams = array(
174 'label' => $params['title'],
177 if ($permission = CRM_Utils_Array
::value('permission', $params)) {
178 $dashletParams['permission'][] = $permission;
182 $transaction = new CRM_Core_Transaction();
184 $instance = self
::add($params);
185 if (is_a($instance, 'CRM_Core_Error')) {
186 $transaction->rollback();
190 // add / update navigation as required
191 if (!empty($navigationParams)) {
192 if (empty($params['id']) && empty($params['instance_id']) && !empty($navigationParams['id'])) {
193 unset($navigationParams['id']);
195 $navigationParams['url'] = "civicrm/report/instance/{$instance->id}" . ($viewMode == 'view' ?
'?reset=1&force=1' : '?reset=1&output=criteria');
196 $navigation = CRM_Core_BAO_Navigation
::add($navigationParams);
198 if (!empty($navigationParams['is_active'])) {
199 //set the navigation id in report instance table
200 CRM_Core_DAO
::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id
, 'navigation_id', $navigation->id
);
203 // has been removed from the navigation bar
204 CRM_Core_DAO
::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id
, 'navigation_id', 'NULL');
207 CRM_Core_BAO_Navigation
::resetNavigation();
211 if (!empty($dashletParams)) {
214 if (!empty($params['charts'])) {
216 $chart = "&charts=" . $params['charts'];
219 if (!empty($params['row_count'])) {
220 $limitResult = '&rowCount=' . $params['row_count'];
222 $dashletParams['name'] = "report/{$instance->id}";
223 $dashletParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashlet" . $limitResult;
224 $dashletParams['fullscreen_url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashletFullscreen" . $limitResult;
225 $dashletParams['instanceURL'] = "civicrm/report/instance/{$instance->id}";
226 CRM_Core_BAO_Dashboard
::addDashlet($dashletParams);
228 $transaction->commit();
234 * Delete the instance of the Report.
239 * $results no of deleted Instance on success, false otherwise
241 public static function del($id = NULL) {
242 $navId = CRM_Core_DAO
::getFieldValue('CRM_Report_DAO_ReportInstance', $id, 'navigation_id', 'id');
243 $dao = new CRM_Report_DAO_ReportInstance();
245 $result = $dao->delete();
247 // Delete navigation if exists.
249 CRM_Core_BAO_Navigation
::processDelete($navId);
250 CRM_Core_BAO_Navigation
::resetNavigation();
258 * @param array $params
259 * @param array $defaults
261 * @return CRM_Report_DAO_ReportInstance|null
263 public static function retrieve($params, &$defaults) {
264 $instance = new CRM_Report_DAO_ReportInstance();
265 $instance->copyValues($params);
267 if ($instance->find(TRUE)) {
268 CRM_Core_DAO
::storeValues($instance, $defaults);
276 * Check if report is private.
278 * @param int $instance_id
282 public static function reportIsPrivate($instance_id) {
283 $owner_id = CRM_Core_DAO
::getFieldValue('CRM_Report_DAO_ReportInstance', $instance_id, 'owner_id', 'id');
291 * Check if the logged in user is the owner.
293 * @param int $instance_id
295 * @return TRUE if contact owns the report, FALSE if not
297 public static function contactIsOwner($instance_id) {
298 $session = CRM_Core_Session
::singleton();
299 $contact_id = $session->get('userID');
300 $owner_id = CRM_Core_DAO
::getFieldValue('CRM_Report_DAO_ReportInstance', $instance_id, 'owner_id', 'id');
301 if ($contact_id === $owner_id) {
308 * Check if the logged in contact can administer the report.
310 * @param int $instance_id
313 * True if contact can edit the private report, FALSE if not.
315 public static function contactCanAdministerReport($instance_id) {
316 if (self
::reportIsPrivate($instance_id)) {
317 if (self
::contactIsOwner($instance_id) || CRM_Core_Permission
::check('access all private reports')) {
321 elseif (CRM_Core_Permission
::check('administer Reports')) {
328 * Delete a report instance wrapped in handling for the form layer.
330 * @param int $instanceId
331 * @param string $bounceTo
332 * Url to redirect the browser to on fail.
333 * @param string $successRedirect
335 public static function doFormDelete($instanceId, $bounceTo = 'civicrm/report/list?reset=1', $successRedirect = NULL) {
336 if (!CRM_Core_Permission
::check('administer Reports')) {
337 $statusMessage = ts('You do not have permission to Delete Report.');
338 CRM_Core_Error
::statusBounce($statusMessage, $bounceTo);
341 CRM_Report_BAO_ReportInstance
::del($instanceId);
343 CRM_Core_Session
::setStatus(ts('Selected report has been deleted.'), ts('Deleted'), 'success');
344 if ($successRedirect) {
345 CRM_Utils_System
::redirect(CRM_Utils_System
::url($successRedirect));
350 * Get the metadata of actions available for this entity.
352 * The thinking here is to describe the various actions on the BAO and then functions
353 * can add a mix of actions from different BAO as appropriate. The crm.SearchForm.js code
354 * transforms the 'confirm_mesage' into a message that needs to be confirmed.
355 * confirm_refresh_fields need to be reviewed & potentially updated at the confirm stage.
357 * Ideas not yet implemented:
358 * - supports_modal task can be loaded in a popup, theoretically worked, not attempted.
359 * - class and or icon - per option icons or classes (I added these in addTaskMenu::addTaskMenu
360 * but I didn't have the right classes). ie adding 'class' => 'crm-i fa-print' to print / class looked
361 * wrong, but at the php level it worked https://github.com/civicrm/civicrm-core/pull/8529#issuecomment-227639091
362 * - general script-add.
364 public static function getActionMetadata() {
366 'report_instance.save' => array('title' => ts('Save')),
367 'report_instance.copy' => array(
368 'title' => ts('Save a Copy'),
370 'is_confirm' => TRUE,
371 'confirm_title' => ts('Save a copy...'),
372 'confirm_refresh_fields' => json_encode(array(
373 'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ts('(Copy) ')),
374 'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
375 'parent_id' => array('selector' => '.crm-report-instanceForm-form-block-parent_id', 'prepend' => ''),
379 'report_instance.print' => array('title' => ts('Print Report')),
380 'report_instance.pdf' => array('title' => ts('Print to PDF')),
381 'report_instance.csv' => array('title' => ts('Export as CSV')),
383 if (CRM_Core_Permission
::check('administer Reports')) {
384 $actions['report_instance.delete'] = array(
385 'title' => ts('Delete report'),
387 'is_confirm' => TRUE,
388 'confirm_message' => ts('Are you sure you want delete this report? This action cannot be undone.'),