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