CRM/Core/Smarty/plugins/block.htxt.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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  * CiviCRM's Smarty gettext plugin
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2020
  33  * $Id$
  34  */
  35
  36 /**
  37  * Smarty block function providing support for
  38  * CiviCRM's helptext mechanism
  39  *
  40  * @param array $params
  41  *   Template call's parameters.
  42  * @param string $text
  43  *   {ts} block contents from the template.
  44  * @param CRM_Core_Smarty $smarty
  45  *   The Smarty object.
  46  *
  47  * @return string
  48  *   the string, translated by gettext
  49  */
  50 function smarty_block_htxt($params, $text, &$smarty) {
  51   if ($params['id'] == $smarty->_tpl_vars['id']) {
  52     $smarty->assign('override_help_text', !empty($params['override']));
  53     return $text;
  54   }
  55   else {
  56     return NULL;
  57   }
  58 }