CRM/Core/Page/Inline/Help.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2014
  31  * $Id$
  32  *
  33  */
  34
  35 /**
  36  * This loads a smarty help file via ajax and returns as html
  37  */
  38 class CRM_Core_Page_Inline_Help {
  39   public function run() {
  40     $args = $_REQUEST;
  41     if (!empty($args['file']) && strpos($args['file'], '..') === FALSE) {
  42       $file = $args['file'] . '.hlp';
  43       $additionalTPLFile = $args['file'] . '.extra.hlp';
  44       $smarty = CRM_Core_Smarty::singleton();
  45       $smarty->assign('id', $args['id']);
  46       CRM_Utils_Array::remove($args, 'file', 'class_name', 'type', 'q', 'id');
  47       foreach ($args as &$arg) {
  48         $arg = strip_tags($arg);
  49       }
  50       $smarty->assign('params', $args);
  51
  52       $extraoutput = '';
  53       if ($smarty->template_exists($additionalTPLFile)) {
  54         //@todo hook has been put here as a conservative approach
  55         // but probably should always run. It doesn't run otherwise because of the exit
  56         CRM_Utils_Hook::pageRun($this);
  57         $extraoutput .= trim($smarty->fetch($additionalTPLFile));
  58       }
  59       exit($smarty->fetch($file) . $extraoutput);
  60     }
  61   }
  62
  63 }