CRM/Core/Smarty/plugins/function.crmSetting.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  *
  30  * @package CRM
  31  * @copyright TTTP
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Retrieve CiviCRM settings from the api for use in templates.
  38  *
  39  * @param $params
  40  * @param $smarty
  41  *
  42  * @return int|string|null
  43  */
  44 function smarty_function_crmSetting($params, &$smarty) {
  45
  46   $errorScope = CRM_Core_TemporaryErrorScope::create(['CRM_Utils_REST', 'fatal']);
  47   unset($params['method']);
  48   unset($params['assign']);
  49   $params['version'] = 3;
  50
  51   require_once 'api/api.php';
  52   $result = civicrm_api('setting', 'getvalue', $params);
  53   unset($errorScope);
  54   // Core-688 FALSE is returned by Boolean settings, thus giving false errors.
  55   if ($result === NULL) {
  56     $smarty->trigger_error("Unknown error");
  57     return NULL;
  58   }
  59
  60   if (empty($params['var'])) {
  61     return is_numeric($result) ? $result : json_encode($result);
  62   }
  63   if (!empty($params['json'])) {
  64     $smarty->assign($params["var"], json_encode($result));
  65   }
  66   else {
  67     $smarty->assign($params["var"], $result);
  68   }
  69 }