3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Report_BAO_ReportInstance
extends CRM_Report_DAO_ReportInstance
{
38 * Takes an associative array and creates an instance object.
40 * the function extract all the params it needs to initialize the create a
41 * instance object. the params array could contain additional unused name/value
44 * @param array $params
45 * (reference ) an assoc array of name/value pairs.
47 * @return CRM_Report_DAO_ReportInstance
49 public static function add(&$params) {
50 $instance = new CRM_Report_DAO_ReportInstance();
55 $instanceID = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('instance_id', $params));
57 // convert roles array to string
58 if (isset($params['grouprole']) && is_array($params['grouprole'])) {
59 $grouprole_array = array();
60 foreach ($params['grouprole'] as $key => $value) {
61 $grouprole_array[$value] = $value;
63 $params['grouprole'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
64 array_keys($grouprole_array)
68 if (!$instanceID ||
!isset($params['id'])) {
69 $params['is_reserved'] = CRM_Utils_Array
::value('is_reserved', $params, FALSE);
70 $params['domain_id'] = CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
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);
122 * takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc.
124 * This function is invoked from within the web form layer and also from the api layer
126 * @param array $params
127 * (reference ) an assoc array of name/value pairs.
129 * @return CRM_Report_BAO_ReportInstance
131 public static function &create(&$params) {
132 if (isset($params['report_header'])) {
133 $params['header'] = CRM_Utils_Array
::value('report_header', $params);
135 if (isset($params['report_footer'])) {
136 $params['footer'] = CRM_Utils_Array
::value('report_footer', $params);
139 // build navigation parameters
140 if (!empty($params['is_navigation'])) {
141 if (!array_key_exists('navigation', $params)) {
142 $params['navigation'] = array();
144 $navigationParams =& $params['navigation'];
146 $navigationParams['permission'] = array();
147 $navigationParams['label'] = $params['title'];
148 $navigationParams['name'] = $params['title'];
150 $navigationParams['current_parent_id'] = CRM_Utils_Array
::value('parent_id', $navigationParams);
151 $navigationParams['parent_id'] = CRM_Utils_Array
::value('parent_id', $params);
152 $navigationParams['is_active'] = 1;
154 if ($permission = CRM_Utils_Array
::value('permission', $params)) {
155 $navigationParams['permission'][] = $permission;
158 // unset the navigation related elements, not used in report form values
159 unset($params['parent_id']);
160 unset($params['is_navigation']);
164 $dashletParams = array();
165 if (!empty($params['addToDashboard'])) {
166 $dashletParams = array(
167 'label' => $params['title'],
170 if ($permission = CRM_Utils_Array
::value('permission', $params)) {
171 $dashletParams['permission'][] = $permission;
175 $transaction = new CRM_Core_Transaction();
177 $instance = self
::add($params);
178 if (is_a($instance, 'CRM_Core_Error')) {
179 $transaction->rollback();
183 // add / update navigation as required
184 if (!empty($navigationParams)) {
185 if (empty($params['id']) && empty($params['instance_id']) && !empty($navigationParams['id'])) {
186 unset($navigationParams['id']);
188 $navigationParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1";
189 $navigation = CRM_Core_BAO_Navigation
::add($navigationParams);
191 if (!empty($navigationParams['is_active'])) {
192 //set the navigation id in report instance table
193 CRM_Core_DAO
::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id
, 'navigation_id', $navigation->id
);
196 // has been removed from the navigation bar
197 CRM_Core_DAO
::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id
, 'navigation_id', 'NULL');
200 CRM_Core_BAO_Navigation
::resetNavigation();
204 if (!empty($dashletParams)) {
207 if (!empty($params['charts'])) {
209 $chart = "&charts=" . $params['charts'];
212 if (CRM_Utils_Array
::value('row_count', $params)) {
213 $limitResult = '&rowCount=' . $params['row_count'];
215 $dashletParams['name'] = "report/{$instance->id}";
216 $dashletParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashlet" . $limitResult;
217 $dashletParams['fullscreen_url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashletFullscreen" . $limitResult;
218 $dashletParams['instanceURL'] = "civicrm/report/instance/{$instance->id}";
219 CRM_Core_BAO_Dashboard
::addDashlet($dashletParams);
221 $transaction->commit();
227 * Delete the instance of the Report.
232 * $results no of deleted Instance on success, false otherwise
234 public static function del($id = NULL) {
235 $dao = new CRM_Report_DAO_ReportInstance();
237 return $dao->delete();
241 * @param array $params
244 * @return CRM_Report_DAO_ReportInstance|null
246 public static function retrieve($params, &$defaults) {
247 $instance = new CRM_Report_DAO_ReportInstance();
248 $instance->copyValues($params);
250 if ($instance->find(TRUE)) {
251 CRM_Core_DAO
::storeValues($instance, $defaults);