/** * Creates or updates an Dashlet. * * @param array $params Associative array of property name/value * pairs for the Dashlet. * * @return array Array containing 'is_error' to denote success or failure and details of the created activity * */ function civicrm_api3_dashboard_create($params) { if (empty($params['id'])) { civicrm_api3_verify_one_mandatory($params, NULL, array('name', 'label', 'url', 'fullscreen_url')); } // create dashboard element $dashboardBAO = CRM_Core_BAO_Dashboard::addDashlet($params); if (isset($dashboardBAO->id)) { _civicrm_api3_object_to_array($dashboardBAO, $dashboardArray[$dashboardBAO->id]); return civicrm_api3_create_success($dashboardArray, $params, 'dashboard', 'create', $dashboardBAO); } }
/** * Create instance. * takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc. * * This function is invoked from within the web form layer and also from the api layer * * @param array $params * (reference ) an assoc array of name/value pairs. * * @return CRM_Report_BAO_ReportInstance */ public static function &create(&$params) { if (isset($params['report_header'])) { $params['header'] = CRM_Utils_Array::value('report_header', $params); } if (isset($params['report_footer'])) { $params['footer'] = CRM_Utils_Array::value('report_footer', $params); } // build navigation parameters if (!empty($params['is_navigation'])) { if (!array_key_exists('navigation', $params)) { $params['navigation'] = array(); } $navigationParams =& $params['navigation']; $navigationParams['permission'] = array(); $navigationParams['label'] = $params['title']; $navigationParams['name'] = $params['title']; $navigationParams['current_parent_id'] = CRM_Utils_Array::value('parent_id', $navigationParams); $navigationParams['parent_id'] = CRM_Utils_Array::value('parent_id', $params); $navigationParams['is_active'] = 1; if ($permission = CRM_Utils_Array::value('permission', $params)) { $navigationParams['permission'][] = $permission; } // unset the navigation related elements, not used in report form values unset($params['parent_id']); unset($params['is_navigation']); } // add to dashboard $dashletParams = array(); if (!empty($params['addToDashboard'])) { $dashletParams = array('label' => $params['title'], 'is_active' => 1); if ($permission = CRM_Utils_Array::value('permission', $params)) { $dashletParams['permission'][] = $permission; } } $transaction = new CRM_Core_Transaction(); $instance = self::add($params); if (is_a($instance, 'CRM_Core_Error')) { $transaction->rollback(); return $instance; } // add / update navigation as required if (!empty($navigationParams)) { if (empty($params['id']) && empty($params['instance_id']) && !empty($navigationParams['id'])) { unset($navigationParams['id']); } $navigationParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1"; $navigation = CRM_Core_BAO_Navigation::add($navigationParams); if (!empty($navigationParams['is_active'])) { //set the navigation id in report instance table CRM_Core_DAO::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id, 'navigation_id', $navigation->id); } else { // has been removed from the navigation bar CRM_Core_DAO::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id, 'navigation_id', 'NULL'); } //reset navigation CRM_Core_BAO_Navigation::resetNavigation(); } // add to dashlet if (!empty($dashletParams)) { $section = 2; $chart = ''; if (!empty($params['charts'])) { $section = 1; $chart = "&charts=" . $params['charts']; } $limitResult = NULL; if (!empty($params['row_count'])) { $limitResult = '&rowCount=' . $params['row_count']; } $dashletParams['name'] = "report/{$instance->id}"; $dashletParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashlet" . $limitResult; $dashletParams['fullscreen_url'] = "civicrm/report/instance/{$instance->id}?reset=1§ion={$section}&snippet=5{$chart}&context=dashletFullscreen" . $limitResult; $dashletParams['instanceURL'] = "civicrm/report/instance/{$instance->id}"; CRM_Core_BAO_Dashboard::addDashlet($dashletParams); } $transaction->commit(); return $instance; }
static function postProcess(&$form) { $params = $form->getVar('_params'); $config = CRM_Core_Config::singleton(); $params['header'] = $params['report_header']; $params['footer'] = $params['report_footer']; $params['domain_id'] = CRM_Core_Config::domainID(); $form->_navigation['permission'] = array(); $form->_navigation['label'] = $params['title']; $form->_navigation['name'] = $params['title']; //navigation parameters if (CRM_Utils_Array::value('is_navigation', $params)) { $permission = CRM_Utils_Array::value('permission', $params); $form->_navigation['current_parent_id'] = CRM_Utils_Array::value('parent_id', $form->_navigation); $form->_navigation['parent_id'] = CRM_Utils_Array::value('parent_id', $params); $form->_navigation['is_active'] = 1; if ($permission) { $form->_navigation['permission'][] = $permission; } //unset the navigation related element, //not used in report form values unset($params['parent_id']); unset($params['is_navigation']); } // convert roles array to string if (isset($params['grouprole']) && is_array($params['grouprole'])) { $grouprole_array = array(); foreach ($params['grouprole'] as $key => $value) { $grouprole_array[$value] = $value; } $params['grouprole'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($grouprole_array)); } // add to dashboard $dashletParams = array(); if (CRM_Utils_Array::value('addToDashboard', $params)) { $dashletParams = array('label' => $params['title'], 'is_active' => 1); $permission = CRM_Utils_Array::value('permission', $params); if ($permission) { $dashletParams['permission'][] = $permission; } } $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE); $dao = new CRM_Report_DAO_Instance(); $dao->copyValues($params); if ($config->userFramework == 'Joomla') { $dao->permission = 'null'; } // explicitly set to null if params value is empty if (empty($params['grouprole'])) { $dao->grouprole = 'null'; } // unset all the params that we use $fields = array('title', 'to_emails', 'cc_emails', 'header', 'footer', 'qfKey', '_qf_default', 'report_header', 'report_footer', 'grouprole'); foreach ($fields as $field) { unset($params[$field]); } $dao->form_values = serialize($params); $instanceID = $form->getVar('_id'); $isNew = $form->getVar('_createNew'); if ($instanceID && !$isNew) { $dao->id = $instanceID; } $dao->report_id = CRM_Report_Utils_Report::getValueFromUrl($instanceID); $dao->save(); $form->set('id', $dao->id); $reloadTemplate = FALSE; if ($dao->id) { if (!empty($form->_navigation)) { if ($isNew && CRM_Utils_Array::value('id', $form->_navigation)) { unset($form->_navigation['id']); } $form->_navigation['url'] = "civicrm/report/instance/{$dao->id}&reset=1"; $navigation = CRM_Core_BAO_Navigation::add($form->_navigation); if (CRM_Utils_Array::value('is_active', $form->_navigation)) { //set the navigation id in report instance table CRM_Core_DAO::setFieldValue('CRM_Report_DAO_Instance', $dao->id, 'navigation_id', $navigation->id); } else { // has been removed from the navigation bar CRM_Core_DAO::setFieldValue('CRM_Report_DAO_Instance', $dao->id, 'navigation_id', 'NULL'); } //reset navigation CRM_Core_BAO_Navigation::resetNavigation(); // in order to reflect change in navigation, template needs to be reloaded $reloadTemplate = TRUE; } // add to dashlet if (!empty($dashletParams)) { $section = 2; $chart = ''; if (CRM_Utils_Array::value('charts', $params)) { $section = 1; $chart = "&charts=" . $params['charts']; } $dashletParams['url'] = "civicrm/report/instance/{$dao->id}&reset=1§ion={$section}&snippet=5{$chart}&context=dashlet"; $dashletParams['fullscreen_url'] = "civicrm/report/instance/{$dao->id}&reset=1§ion={$section}&snippet=5{$chart}&context=dashletFullscreen"; $dashletParams['instanceURL'] = "civicrm/report/instance/{$dao->id}"; CRM_Core_BAO_Dashboard::addDashlet($dashletParams); } $instanceParams = array('value' => $dao->report_id); $instanceDefaults = array(); $cmpName = "Contact"; $statusMsg = "null"; CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_OptionValue', $instanceParams, $instanceDefaults); if ($cmpID = CRM_Utils_Array::value('component_id', $instanceDefaults)) { $cmpName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Component', $cmpID, 'name', 'id'); $cmpName = substr($cmpName, 4); } // Url to view this report and others created FROM this template $instanceUrl = CRM_Utils_System::url('civicrm/report/list', "reset=1&ovid={$instanceDefaults['id']}"); $statusMsg = ts('Report "%1" has been created and is now available in the <a href="%3">report listings under "%2" Reports</a>.', array(1 => $dao->title, 2 => $cmpName, 3 => $instanceUrl)); if ($instanceID && !$isNew) { $statusMsg = ts('Report "%1" has been updated.', array(1 => $dao->title)); } CRM_Core_Session::setStatus($statusMsg); } if ($reloadTemplate) { // as there's been change in navigation, reload the template return CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'force=1')); } }
static function postProcess(&$form) { $params = $form->getVar('_params'); $config = CRM_Core_Config::singleton(); $params['header'] = $params['report_header']; $params['footer'] = $params['report_footer']; $params['domain_id'] = CRM_Core_Config::domainID(); //navigation parameters if (CRM_Utils_Array::value('is_navigation', $params)) { $form->_navigation['permission'] = array(); $permission = CRM_Utils_Array::value('permission', $params); $form->_navigation['current_parent_id'] = CRM_Utils_Array::value('parent_id', $form->_navigation); $form->_navigation['parent_id'] = CRM_Utils_Array::value('parent_id', $params); $form->_navigation['label'] = $params['title']; $form->_navigation['name'] = $params['title']; $form->_navigation['is_active'] = 1; if ($permission) { $form->_navigation['permission'][] = $permission; } //unset the navigation related element, //not used in report form values unset($params['parent_id']); unset($params['is_navigation']); } // add to dashboard $dashletParams = array(); if (CRM_Utils_Array::value('addToDashboard', $params)) { $dashletParams = array('label' => $params['title'], 'is_active' => 1, 'content' => 'NULL'); $permission = CRM_Utils_Array::value('permission', $params); if ($permission) { $dashletParams['permission'][] = $permission; } unset($params['addToDashboard']); } require_once 'CRM/Report/DAO/Instance.php'; $dao = new CRM_Report_DAO_Instance(); $dao->copyValues($params); if ($config->userFramework == 'Joomla') { $dao->permission = NULL; } // unset all the params that we use $fields = array('title', 'to_emails', 'cc_emails', 'header', 'footer', 'qfKey', '_qf_default', 'report_header', 'report_footer'); foreach ($fields as $field) { unset($params[$field]); } $dao->form_values = serialize($params); $instanceID = $form->getVar('_id'); if ($instanceID) { $dao->id = $instanceID; } require_once 'CRM/Report/Utils/Report.php'; $dao->report_id = CRM_Report_Utils_Report::getValueFromUrl($instanceID); $dao->save(); $form->set('id', $dao->id); $reloadTemplate = false; if ($dao->id) { if (!empty($form->_navigation)) { $form->_navigation['url'] = "civicrm/report/instance/{$dao->id}&reset=1"; $navigation = CRM_Core_BAO_Navigation::add($form->_navigation); //set the navigation id in report instance table CRM_Core_DAO::setFieldValue('CRM_Report_DAO_Instance', $dao->id, 'navigation_id', $navigation->id); //reset navigation CRM_Core_BAO_Navigation::resetNavigation(); // in order to reflect change in navigation, template needs to be reloaded $reloadTemplate = true; } // add to dashlet if (!empty($dashletParams)) { $section = 2; $chart = ''; if (CRM_Utils_Array::value('charts', $params)) { $section = 1; $chart = "&charts=" . $params['charts']; $dashletParams['is_fullscreen'] = 0; } $dashletParams['url'] = "civicrm/report/instance/{$dao->id}&reset=1§ion={$section}&snippet=4{$chart}"; $dashletParams['instanceURL'] = "civicrm/report/instance/{$dao->id}"; require_once 'CRM/Core/BAO/Dashboard.php'; CRM_Core_BAO_Dashboard::addDashlet($dashletParams); } $instanceParams = array('value' => $dao->report_id); $instanceDefaults = array(); $cmpName = "Contact"; $statusMsg = "null"; CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_OptionValue', $instanceParams, $instanceDefaults); if ($cmpID = CRM_Utils_Array::value('component_id', $instanceDefaults)) { $cmpName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Component', $cmpID, 'name', 'id'); $cmpName = substr($cmpName, 4); } // Url to view this report and others created FROM this template $instanceUrl = CRM_Utils_System::url('civicrm/report/list', "reset=1&ovid={$instanceDefaults['id']}"); $statusMsg = ts('Report "%1" has been created and is now available in the <a href="%3">report listings under "%2" Reports</a>.', array(1 => $dao->title, 2 => $cmpName, 3 => $instanceUrl)); if ($instanceID) { $statusMsg = ts('Report "%1" has been updated.', array(1 => $dao->title)); } CRM_Core_Session::setStatus($statusMsg); } if ($reloadTemplate) { // as there's been change in navigation, reload the template return CRM_Utils_System::redirect(CRM_Utils_System::url(CRM_Utils_System::currentPath(), 'force=1')); } }