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

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC
  16  *
  17  */
  18
  19 /**
  20  * Add a Javascript file to a specific part of the page
  21  *
  22  * @param array $params
  23  *   Array with keys:
  24  *   - ext: string, extension name. see CRM_Core_Resources::addScriptFile
  25  *   - file: string, relative file path. see CRM_Core_Resources::addScriptFile
  26  *   - url: string. see CRM_Core_Resources::addScriptURL
  27  *   - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
  28  *   - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
  29  * @param CRM_Core_Smarty $smarty
  30  *
  31  * @throws Exception
  32  */
  33 function smarty_function_crmScript($params, &$smarty) {
  34   $params += [
  35     'weight' => CRM_Core_Resources::DEFAULT_WEIGHT,
  36     'region' => CRM_Core_Resources::DEFAULT_REGION,
  37     'ext' => 'civicrm',
  38   ];
  39
  40   if (array_key_exists('file', $params)) {
  41     Civi::resources()->addScriptFile($params['ext'], $params['file'], $params['weight'], $params['region']);
  42   }
  43   elseif (array_key_exists('url', $params)) {
  44     Civi::resources()->addScriptUrl($params['url'], $params['weight'], $params['region']);
  45   }
  46   else {
  47     CRM_Core_Error::debug_var('crmScript_params', $params);
  48     throw new Exception("crmScript requires url or ext+file");
  49   }
  50 }