CRM/Core/Page/Inline/Help.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This loads a smarty help file via ajax and returns as html
  38  */
  39 class CRM_Core_Page_Inline_Help {
  40   function run() {
  41     $args = $_REQUEST;
  42     if (!empty($args['file']) && strpos($args['file'], '..') === FALSE) {
  43       $file = $args['file'] . '.hlp';
  44       $additionalTPLFile = $args['file'] . '.extra.hlp';
  45       $smarty = CRM_Core_Smarty::singleton();
  46       $smarty->assign('id', $args['id']);
  47       CRM_Utils_Array::remove($args, 'file', 'class_name', 'type', 'q', 'id');
  48       foreach ($args as &$arg) {
  49         $arg = strip_tags($arg);
  50       }
  51       $smarty->assign('params', $args);
  52
  53       $extraoutput = '';
  54       if ($smarty->template_exists($additionalTPLFile)) {
  55         //@todo hook has been put here as a conservative approach
  56         // but probably should always run. It doesn't run otherwise because of the exit
  57         CRM_Utils_Hook::pageRun($this);
  58         $extraoutput .= trim($smarty->fetch($additionalTPLFile));
  59       }
  60       exit($smarty->fetch($file) . $extraoutput);
  61     }
  62   }
  63 }