include/Smarty/plugins/function.sugar_help.php

   1 <?php
   2
   3 /*
   4
   5 Modification information for LGPL compliance
   6
   7 r56990 - 2010-06-16 13:05:36 -0700 (Wed, 16 Jun 2010) - kjing - snapshot "Mango" svn branch to a new one for GitHub sync
   8
   9 r56989 - 2010-06-16 13:01:33 -0700 (Wed, 16 Jun 2010) - kjing - defunt "Mango" svn dev branch before github cutover
  10
  11 r55980 - 2010-04-19 13:31:28 -0700 (Mon, 19 Apr 2010) - kjing - create Mango (6.1) based on windex
  12
  13 r51719 - 2009-10-22 10:18:00 -0700 (Thu, 22 Oct 2009) - mitani - Converted to Build 3  tags and updated the build system
  14
  15 r51634 - 2009-10-19 13:32:22 -0700 (Mon, 19 Oct 2009) - mitani - Windex is the branch for Sugar Sales 1.0 development
  16
  17 r50752 - 2009-09-10 15:18:28 -0700 (Thu, 10 Sep 2009) - dwong - Merged branches/tokyo from revision 50372 to 50729 to branches/kobe2
  18 Discard lzhang r50568 changes in Email.php and corresponding en_us.lang.php
  19
  20 r50375 - 2009-08-24 18:07:43 -0700 (Mon, 24 Aug 2009) - dwong - branch kobe2 from tokyo r50372
  21
  22 r42997 - 2009-01-06 13:04:49 -0800 (Tue, 06 Jan 2009) - jmertic - Create a helpInline icon, used for the help icon inside a form. Updated smarty plugin sugar_help to grab the correct icon.
  23
  24 r42807 - 2008-12-29 11:16:59 -0800 (Mon, 29 Dec 2008) - dwong - Branch from trunk/sugarcrm r42806 to branches/tokyo/sugarcrm
  25
  26 r40524 - 2008-10-14 05:27:28 -0700 (Tue, 14 Oct 2008) - jmertic - Fixed a few problems found from the big checkin earlier.
  27
  28 r40493 - 2008-10-13 14:10:05 -0700 (Mon, 13 Oct 2008) - jmertic - Globally change theme image access to use SugarTheme::getImageURL() and SugarTheme::getImage(), instead of previous methods of using getImagePath(), get_image(), or using the $image_path global.
  29
  30 r34454 - 2008-04-21 05:58:55 -0700 (Mon, 21 Apr 2008) - jmertic - Bug 21449: Added new help icon from jyim, and updated smarty function sugar_help to use it.
  31 Added:
  32 - themes/default/images/help.gif
  33 Touched:
  34 - include/Smarty/plugins/function.sugar_help.php
  35
  36 r33864 - 2008-04-07 19:46:34 -0700 (Mon, 07 Apr 2008) - nsingh - more help stuff and UI changes.
  37
  38 r32849 - 2008-03-16 02:50:52 -0700 (Sun, 16 Mar 2008) - majed - reverts changes that for getWebPath template
  39
  40 r32667 - 2008-03-11 17:16:04 -0700 (Tue, 11 Mar 2008) - majed - changes for templating
  41
  42 r32202 - 2008-02-29 11:05:08 -0800 (Fri, 29 Feb 2008) - jmertic - Have sugar_help icon be the magnifying glass and the window not have a title.
  43 Update usage in step1.tpl and step3.tpl.
  44
  45 r32200 - 2008-02-29 10:44:55 -0800 (Fri, 29 Feb 2008) - jmertic - Add string placeholders for several tooltips on Step 3.
  46 Pushed code for help popups into smarty function sugar_help.
  47
  48
  49 */
  50
  51
  52 /**
  53  * Smarty plugin
  54  * @package Smarty
  55  * @subpackage plugins
  56  *
  57  * This is a Smarty plugin to handle the creation of jquery ui dialog popups for inline help
  58  *
  59  * NOTE: Be sure to include the following code somewhere on the page you'll be using this on.
  60  *
  61  *
  62  * @author John Mertic {jmertic@sugarcrm.com}
  63  */
  64
  65 /**
  66  * smarty_function_sugar_help
  67  * This is the constructor for the Smarty plugin.
  68  *
  69  * @param $params The runtime Smarty key/value arguments
  70  * @param $smarty The reference to the Smarty object used in this invocation
  71  */
  72 function smarty_function_sugar_help($params, &$smarty)
  73 {
  74     $text = str_replace("'","\'",htmlspecialchars($params['text']));
  75         //append any additional parameters.
  76         $click  = "return SUGAR.util.showHelpTips(this,'$text'";
  77
  78         if (count( $params) > 1){
  79
  80                         $click .=",'".$params['myPos']."','".$params['atPos']."'";
  81         }
  82     $helpImage = SugarThemeRegistry::current()->getImageURL('helpInline.png');
  83         $click .= " );" ;
  84     $alt_tag = $GLOBALS['app_strings']['LBL_ALT_INFO'];
  85     return <<<EOHTML
  86 <img border="0"
  87     onclick="$click"
  88     src="$helpImage"
  89     alt="$alt_tag"
  90     class="inlineHelpTip"
  91     />
  92 EOHTML;
  93 }
  94
  95 ?>