modules/Home/Dashlets/JotPadDashlet/JotPadDashlet.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once('include/Dashlets/Dashlet.php');
  40
  41
  42 class JotPadDashlet extends Dashlet {
  43     var $savedText; // users's saved text
  44     var $height = '200'; // height of the pad
  45
  46     /**
  47      * Constructor
  48      *
  49      * @global string current language
  50      * @param guid $id id for the current dashlet (assigned from Home module)
  51      * @param array $def options saved for this dashlet
  52      */
  53     function JotPadDashlet($id, $def) {
  54         $this->loadLanguage('JotPadDashlet'); // load the language strings here
  55
  56         if(!empty($def['savedText']))  // load default text is none is defined
  57             $this->savedText = $def['savedText'];
  58         else
  59             $this->savedText = $this->dashletStrings['LBL_DEFAULT_TEXT'];
  60
  61         if(!empty($def['height'])) // set a default height if none is set
  62             $this->height = $def['height'];
  63
  64         parent::Dashlet($id); // call parent constructor
  65
  66         $this->isConfigurable = true; // dashlet is configurable
  67         $this->hasScript = true;  // dashlet has javascript attached to it
  68
  69         // if no custom title, use default
  70         if(empty($def['title'])) $this->title = $this->dashletStrings['LBL_TITLE'];
  71         else $this->title = $def['title'];
  72     }
  73
  74     /**
  75      * Displays the dashlet
  76      *
  77      * @return string html to display dashlet
  78      */
  79     function display() {
  80         $ss = new Sugar_Smarty();
  81         $ss->assign('savedText', SugarCleaner::cleanHtml($this->savedText));
  82         $ss->assign('saving', $this->dashletStrings['LBL_SAVING']);
  83         $ss->assign('saved', $this->dashletStrings['LBL_SAVED']);
  84         $ss->assign('id', $this->id);
  85         $ss->assign('height', $this->height);
  86
  87         $str = $ss->fetch('modules/Home/Dashlets/JotPadDashlet/JotPadDashlet.tpl');
  88         return parent::display($this->dashletStrings['LBL_DBLCLICK_HELP']) . $str . '<br />'; // return parent::display for title and such
  89     }
  90
  91     /**
  92      * Displays the javascript for the dashlet
  93      *
  94      * @return string javascript to use with this dashlet
  95      */
  96     function displayScript() {
  97         $ss = new Sugar_Smarty();
  98         $ss->assign('saving', $this->dashletStrings['LBL_SAVING']);
  99         $ss->assign('saved', $this->dashletStrings['LBL_SAVED']);
 100         $ss->assign('id', $this->id);
 101
 102         $str = $ss->fetch('modules/Home/Dashlets/JotPadDashlet/JotPadDashletScript.tpl');
 103         return $str; // return parent::display for title and such
 104     }
 105
 106     /**
 107      * Displays the configuration form for the dashlet
 108      *
 109      * @return string html to display form
 110      */
 111     function displayOptions() {
 112         global $app_strings;
 113
 114         $ss = new Sugar_Smarty();
 115         $ss->assign('titleLbl', $this->dashletStrings['LBL_CONFIGURE_TITLE']);
 116         $ss->assign('heightLbl', $this->dashletStrings['LBL_CONFIGURE_HEIGHT']);
 117         $ss->assign('saveLbl', $app_strings['LBL_SAVE_BUTTON_LABEL']);
 118         $ss->assign('clearLbl', $app_strings['LBL_CLEAR_BUTTON_LABEL']);
 119         $ss->assign('title', $this->title);
 120         $ss->assign('height', $this->height);
 121         $ss->assign('id', $this->id);
 122
 123         return parent::displayOptions() . $ss->fetch('modules/Home/Dashlets/JotPadDashlet/JotPadDashletOptions.tpl');
 124     }
 125
 126     /**
 127      * called to filter out $_REQUEST object when the user submits the configure dropdown
 128      *
 129      * @param array $req $_REQUEST
 130      * @return array filtered options to save
 131      */
 132     function saveOptions($req) {
 133         global $sugar_config, $timedate, $current_user, $theme;
 134         $options = array();
 135         $options['title'] = $_REQUEST['title'];
 136         if(is_numeric($_REQUEST['height'])) {
 137             if($_REQUEST['height'] > 0 && $_REQUEST['height'] <= 300) $options['height'] = $_REQUEST['height'];
 138             elseif($_REQUEST['height'] > 300) $options['height'] = '300';
 139             else $options['height'] = '100';
 140         }
 141
 142         $options['savedText'] = $this->savedText;
 143         return $options;
 144     }
 145
 146     /**
 147      * Used to save text on textarea blur. Accessed via Home/CallMethodDashlet.php
 148      * This is an example of how to to call a custom method via ajax
 149      */
 150     function saveText() {
 151         $json = getJSONobj();
 152         if(isset($_REQUEST['savedText'])) {
 153             $optionsArray = $this->loadOptions();
 154             $optionsArray['savedText']=$json->decode(html_entity_decode($_REQUEST['savedText']));
 155             $optionsArray['savedText']=SugarCleaner::cleanHtml(nl2br($optionsArray['savedText']));
 156             $this->storeOptions($optionsArray);
 157
 158         }
 159         else {
 160             $optionsArray['savedText'] = '';
 161         }
 162         echo 'result = ' . $json->encode(array('id' => $_REQUEST['id'],
 163                                        'savedText' => $optionsArray['savedText']));
 164     }
 165 }
 166
 167 ?>