3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
39 * @param array $params
40 * The function params.
41 * @param CRM_Core_Smarty $smarty
42 * Reference to the smarty object.
45 * the help html to be inserted
47 function smarty_function_help($params, &$smarty) {
48 if (!isset($params['id']) ||
!isset($smarty->_tpl_vars
['config'])) {
52 if (empty($params['file']) && isset($smarty->_tpl_vars
['tplFile'])) {
53 $params['file'] = $smarty->_tpl_vars
['tplFile'];
55 elseif (empty($params['file'])) {
59 $params['file'] = str_replace(['.tpl', '.hlp'], '', $params['file']);
61 if (empty($params['title'])) {
62 $vars = $smarty->get_template_vars();
63 $smarty->assign('id', $params['id'] . '-title');
64 $name = trim($smarty->fetch($params['file'] . '.hlp'));
65 $additionalTPLFile = $params['file'] . '.extra.hlp';
66 if ($smarty->template_exists($additionalTPLFile)) {
67 $name .= trim($smarty->fetch($additionalTPLFile));
69 // Ensure we didn't change any existing vars CRM-11900
70 foreach ($vars as $key => $value) {
71 if ($smarty->get_template_vars($key) !== $value) {
72 $smarty->assign($key, $value);
77 $name = trim(strip_tags($params['title']));
81 if (!empty($params['class'])) {
82 $class .= " {$params['class']}";
86 $title = htmlspecialchars(ts('%1 Help', [1 => $name]));
87 // Escape for html and js
88 $name = htmlspecialchars(json_encode($name), ENT_QUOTES
);
90 // Format params to survive being passed through json & the url
91 unset($params['text'], $params['title']);
92 foreach ($params as &$param) {
93 $param = is_bool($param) ||
is_numeric($param) ?
(int) $param : (string) $param;
95 return '<a class="' . $class . '" title="' . $title . '" aria-label="' . $title . '" href="#" onclick=\'CRM.help(' . $name . ', ' . json_encode($params) . '); return false;\'> </a>';