CRM/Core/Smarty/plugins/function.docURL.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 https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Given one of: ( page, title, text ) parameters, generates
  20  * an HTML link to documentation.
  21  *
  22  * @param array $params
  23  *   The function params.
  24  * @param CRM_Core_Smarty $smarty
  25  *   Reference to the smarty object.
  26  *
  27  * @return string|NULL
  28  *   HTML code of a link to documentation
  29  */
  30 function smarty_function_docURL($params, &$smarty) {
  31   if (!isset($smarty)) {
  32     return NULL;
  33   }
  34   else {
  35     return CRM_Utils_System::docURL($params);
  36   }
  37 }