CRM/Core/Smarty/plugins/function.help.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Adds inline help
  38  *
  39  * @param array  $params the function params
  40  * @param object $smarty reference to the smarty object
  41  *
  42  * @return string the help html to be inserted
  43  * @access public
  44  */
  45 function smarty_function_help($params, &$smarty) {
  46   if (!isset($params['id']) || !isset($smarty->_tpl_vars['config'])) {
  47     return;
  48   }
  49
  50   if (empty($params['file']) && isset($smarty->_tpl_vars['tplFile'])) {
  51     $params['file'] = $smarty->_tpl_vars['tplFile'];
  52   }
  53   elseif (empty($params['file'])) {
  54     return NULL;
  55   }
  56
  57   $params['file'] = str_replace(array('.tpl', '.hlp'), '', $params['file']);
  58
  59   if (empty($params['title'])) {
  60     // Avod overwriting existing vars CRM-11900
  61     $oldID = $smarty->get_template_vars('id');
  62     $smarty->assign('id', $params['id'] . '-title');
  63     $name = trim($smarty->fetch($params['file'] . '.hlp'));
  64     $additionalTPLFile = $params['file'] . '.extra.hlp';
  65     if ($smarty->template_exists($additionalTPLFile)) {
  66       $name .= trim($smarty->fetch($additionalTPLFile));
  67     }
  68     $smarty->assign('id', $oldID);
  69   }
  70   else {
  71     $name = trim(strip_tags($params['title']));
  72   }
  73
  74   // Escape for html
  75   $title = htmlspecialchars(ts('%1 Help', array(1 => $name)));
  76   // Escape for html and js
  77   $name = htmlspecialchars(json_encode($name), ENT_QUOTES);
  78
  79   // Format params to survive being passed through json & the url
  80   unset($params['text'], $params['title']);
  81   foreach ($params as &$param) {
  82     $param = is_bool($param) || is_numeric($param) ? (int) $param : (string) $param;
  83   }
  84   return '<a class="helpicon" title="' . $title . '" href="#" onclick=\'CRM.help(' . $name . ', ' . json_encode($params) . '); return false;\'>&nbsp;</a>';
  85 }