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

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Add a Javascript file to a specific part of the page
  38  *
  39  * @param array $params
  40  *   Array with keys:
  41  *   - ext: string, extension name. see CRM_Core_Resources::addScriptFile
  42  *   - file: string, relative file path. see CRM_Core_Resources::addScriptFile
  43  *   - url: string. see CRM_Core_Resources::addScriptURL
  44  *   - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
  45  *   - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
  46  * @param CRM_Core_Smarty $smarty
  47  *
  48  * @throws Exception
  49  */
  50 function smarty_function_crmScript($params, &$smarty) {
  51   $params += [
  52     'weight' => CRM_Core_Resources::DEFAULT_WEIGHT,
  53     'region' => CRM_Core_Resources::DEFAULT_REGION,
  54     'ext' => 'civicrm',
  55   ];
  56
  57   if (array_key_exists('file', $params)) {
  58     Civi::resources()->addScriptFile($params['ext'], $params['file'], $params['weight'], $params['region']);
  59   }
  60   elseif (array_key_exists('url', $params)) {
  61     Civi::resources()->addScriptUrl($params['url'], $params['weight'], $params['region']);
  62   }
  63   else {
  64     CRM_Core_Error::debug_var('crmScript_params', $params);
  65     throw new Exception("crmScript requires url or ext+file");
  66   }
  67 }