';
$blankImageURL = SugarThemeRegistry::current()->getImageURL('blank.gif');
$printImageURL = SugarThemeRegistry::current()->getImageURL("print.gif");
$helpImageURL = SugarThemeRegistry::current()->getImageURL("help.gif");
$keywords = array("/class=\"button\"/","/class='button'/","/class=button/","/<\/form>/");
$match = false;
foreach ($keywords as $left) {
if (preg_match($left, $title)) {
$match = true;
}
}
$other_text_and_match = false;
if ($title && $match) {
$other_text_and_match = true;
}
$template = new Sugar_Smarty();
$template->assign('sugar_version', $sugar_version);
$template->assign('sugar_flavor', $sugar_flavor);
$template->assign('server_unique_key', $server_unique_key);
$template->assign('current_language', $current_language);
$template->assign('current_module', $current_module);
$template->assign('current_action', $current_action);
$template->assign('app_strings', $app_strings);
$template->assign('match', $match);
$template->assign('other_text_and_match', $other_text_and_match);
$template->assign('blankImageURL', $blankImageURL);
$template->assign('printImageURL', $printImageURL);
$template->assign('helpImageURL', $helpImageURL);
// $template->assign('show_help', $show_help);
$template->assign('other_text', $title);
$template->assign('form_title', $this->title);
$template->assign('SUGAR_CONFIG', $sugar_config);
$template->assign('DASHLET_TITLE', $this->title);
$template->assign('DASHLET_ID', $this->id);
$template->assign('CONFIGURE_ICON', $this->setConfigureIcon());
$template->assign('REFRESH_ICON', $this->setRefreshIcon());
$template->assign('DELETE_ICON', $this->setDeleteIcon());
$moduleName = '';
if (!is_object($this->seedBean)) {
$GLOBALS['log']->warn('incorrect seed bean');
} else {
$moduleName = $this->seedBean->module_name;
}
$template->assign('DASHLET_MODULE', $moduleName);
$template->assign('DASHLET_BUTTON_ARIA_EDIT', translate('LBL_DASHLET_EDIT', 'Home'));
$template->assign('DASHLET_BUTTON_ARIA_REFRESH', translate('LBL_DASHLET_REFRESH', 'Home'));
$template->assign('DASHLET_BUTTON_ARIA_DELETE', translate('LBL_DASHLET_DELETE', 'Home'));
$template->assign('GET_FORM_HEADER', get_form_header($this->title, $title, false));
$template->assign('HEADER', $str);
return $template->fetch('include/Dashlets/DashletHeader.tpl');
}
/**
* Called when Dashlet is displayed
*
* @return string footer HTML
*/
public function getFooter()
{
global $sugar_config, $sugar_version, $sugar_flavor, $server_unique_key, $current_language, $current_module, $current_action, $app_strings;
$blankImageURL = SugarThemeRegistry::current()->getImageURL('blank.gif');
$printImageURL = SugarThemeRegistry::current()->getImageURL("print.gif");
$helpImageURL = SugarThemeRegistry::current()->getImageURL("help.gif");
$template = new Sugar_Smarty();
$template->assign('sugar_version', $sugar_version);
$template->assign('sugar_flavor', $sugar_flavor);
$template->assign('server_unique_key', $server_unique_key);
$template->assign('current_language', $current_language);
$template->assign('current_module', $current_module);
$template->assign('current_action', $current_action);
$template->assign('app_strings', $app_strings);
$template->assign('blankImageURL', $blankImageURL);
$template->assign('printImageURL', $printImageURL);
$template->assign('helpImageURL', $helpImageURL);
// $template->assign('show_help', $show_help);
$template->assign('form_title', $this->title);
$template->assign('SUGAR_CONFIG', $sugar_config);
$template->assign('DASHLET_TITLE', $this->title);
$template->assign('DASHLET_ID', $this->id);
$template->assign('CONFIGURE_ICON', $this->setConfigureIcon());
$template->assign('REFRESH_ICON', $this->setRefreshIcon());
$template->assign('DELETE_ICON', $this->setDeleteIcon());
return $template->fetch('include/Dashlets/DashletFooter.tpl');
}
/**
* Called when Dashlet is displayed, override this
*
* @return string title HTML
*/
public function display()
{
return '';
}
/**
* Called when Dashlets configuration options are called
*/
public function displayOptions()
{
}
/**
* Override if you need to do pre-processing before display is called
*/
public function process()
{
}
/**
* Processes and displays the auto refresh code for the dashlet
*
* @param int $dashletOffset
* @return string HTML code
*/
protected function processAutoRefresh($dashletOffset = 0)
{
global $sugar_config;
if (empty($dashletOffset)) {
$dashletOffset = 0;
$module = $_REQUEST['module'];
if (isset($_REQUEST[$module.'2_'.strtoupper($this->seedBean->object_name).'_offset'])) {
$dashletOffset = $_REQUEST[$module.'2_'.strtoupper($this->seedBean->object_name).'_offset'];
}
}
if (!$this->isRefreshable) {
return '';
}
if (!empty($sugar_config['dashlet_auto_refresh_min']) && $sugar_config['dashlet_auto_refresh_min'] == -1) {
return '';
}
$autoRefreshSS = new Sugar_Smarty();
$autoRefreshSS->assign('dashletOffset', $dashletOffset);
$autoRefreshSS->assign('dashletId', $this->id);
$autoRefreshSS->assign('strippedDashletId', str_replace("-", "", $this->id)); //javascript doesn't like "-" in function names
$autoRefreshSS->assign('dashletRefreshInterval', $this->getAutoRefresh());
$tpl = 'include/Dashlets/DashletGenericAutoRefresh.tpl';
if ($_REQUEST['action'] == "DynamicAction") {
$tpl = 'include/Dashlets/DashletGenericAutoRefreshDynamic.tpl';
}
return $autoRefreshSS->fetch($tpl);
}
protected function getAutoRefresh()
{
global $sugar_config;
if (empty($this->autoRefresh) || $this->autoRefresh == -1) {
$autoRefresh = 0;
} elseif (!empty($sugar_config['dashlet_auto_refresh_min'])
&& $this->autoRefresh > 0
&& $sugar_config['dashlet_auto_refresh_min'] > $this->autoRefresh) {
$autoRefresh = $sugar_config['dashlet_auto_refresh_min'];
} else {
$autoRefresh = $this->autoRefresh;
}
$ret = $autoRefresh * 1000;
/**
This number is used by setInterval() function in JS
We should consider a limit of 2**31 -1
https://stackoverflow.com/questions/12633405/what-is-the-maximum-delay-for-setinterval/12633556#comment78208539_12633488
*/
if ($ret > (pow(2, 31) - 1)) {
$ret = pow(2, 31) - 1;
LoggerManager::getLogger()->warn(
"The value of autoRefresh key in Dashlet: {$this->title} must be less than 2.147.483 seconds."
."{$autoRefresh} was configured. Using 2.147.483 seconds instead."
);
}
return $ret;
}
/**
* Override this if your dashlet is configurable (this is called when the the configureDashlet form is shown)
* Filters the array for only the parameters it needs to save
*
* @param array $req the array to pull options from
* @return array options array
*/
public function saveOptions($req)
{
}
/**
* Sets the language strings
*
* @param string $dashletClassname classname of the dashlet
* @param string $dashletDirectory directory path of the dashlet
*/
public function loadLanguage($dashletClassname, $dashletDirectory = 'modules/Home/Dashlets/')
{
global $current_language, $dashletStrings;
if (!isset($dashletStrings[$dashletClassname])) {
// load current language strings for current language, else default to english
if (is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')
|| is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')) {
if (is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')) {
require($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php');
}
if (is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')) {
require('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php');
}
} else {
if (is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php')) {
require($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php');
}
if (is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php')) {
require('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php');
}
}
}
$this->dashletStrings = $dashletStrings[$dashletClassname];
}
/**
* Generic way to store an options array into UserPreferences
*
* @param array $optionsArray the array to save
*/
public function storeOptions($optionsArray)
{
global $current_user;
$dashletDefs = $current_user->getPreference('dashlets', 'Home'); // load user's dashlets config
$dashletDefs[$this->id]['options'] = $optionsArray;
$current_user->setPreference('dashlets', $dashletDefs, 0, 'Home');
}
/**
* Generic way to retrieve options array from UserPreferences
*
* @return array options array stored in UserPreferences
*/
public function loadOptions()
{
global $current_user;
$dashletDefs = $current_user->getPreference('dashlets', 'Home'); // load user's dashlets config
if (isset($dashletDefs[$this->id]['options'])) {
return $dashletDefs[$this->id]['options'];
} else {
return array();
}
}
/**
* Override this in the subclass. It is used to determine whether the dashlet can be displayed.
*
* @return bool indicating whether or not the current user has access to display this Dashlet.
*/
public function hasAccess()
{
return true;
}
/**
* Returns the available auto refresh settings you can set a dashlet to
*
* @return array options available
*/
protected function getAutoRefreshOptions()
{
$options = $GLOBALS['app_list_strings']['dashlet_auto_refresh_options'];
if (isset($GLOBALS['sugar_config']['dashlet_auto_refresh_min'])) {
foreach ($options as $time => $desc) {
if ($time != -1 && $time < $GLOBALS['sugar_config']['dashlet_auto_refresh_min']) {
unset($options[$time]);
}
}
}
return $options;
}
/**
* Returns true if the dashlet is auto refreshable
*
* @return bool
*/
protected function isAutoRefreshable()
{
return $this->isRefreshable &&
(isset($GLOBALS['sugar_config']['dashlet_auto_refresh_min']) ?
$GLOBALS['sugar_config']['dashlet_auto_refresh_min'] != -1 : true);
}
}