CRM/Core/Page.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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * A Page is basically data in a nice pretty format.
  38  *
  39  * Pages should not have any form actions / elements in them. If they
  40  * do, make sure you use CRM_Core_Form and the related structures. You can
  41  * embed simple forms in Page and do your own form handling.
  42  *
  43  */
  44 class CRM_Core_Page {
  45
  46   /**
  47    * The name of the page (auto generated from class name)
  48    *
  49    * @var string
  50    */
  51   protected $_name;
  52
  53   /**
  54    * The title associated with this page
  55    *
  56    * @var object
  57    */
  58   protected $_title;
  59
  60   /**
  61    * A page can have multiple modes. (i.e. displays
  62    * a different set of data based on the input
  63    * @var int
  64    */
  65   protected $_mode;
  66
  67   /**
  68    * Is this object being embedded in another object. If
  69    * so the display routine needs to not do any work. (The
  70    * parent object takes care of the display)
  71    *
  72    * @var boolean
  73    */
  74   protected $_embedded = FALSE;
  75
  76   /**
  77    * Are we in print mode? if so we need to modify the display
  78    * functionality to do a minimal display :)
  79    *
  80    * @var boolean
  81    */
  82   protected $_print = FALSE;
  83
  84   /**
  85    * Cache the smarty template for efficiency reasons
  86    *
  87    * @var CRM_Core_Smarty
  88    * @static
  89    */
  90   static protected $_template;
  91
  92   /**
  93    * Cache the session for efficiency reasons
  94    *
  95    * @var CRM_Core_Session
  96    * @static
  97    */
  98   static protected $_session;
  99
 100   /**
 101    * What to return to the client if in ajax mode (snippet=json)
 102    *
 103    * @var array
 104    */
 105   public $ajaxResponse = array();
 106
 107   /**
 108    * Url path used to reach this page
 109    *
 110    * @var array
 111    */
 112   public $urlPath = array();
 113
 114   /**
 115    * Should crm.livePage.js be added to the page?
 116    * @var bool
 117    */
 118   public $useLivePageJS;
 119
 120   /**
 121    * Class constructor
 122    *
 123    * @param string $title title of the page
 124    * @param int    $mode  mode of the page
 125    *
 126    * @return CRM_Core_Page
 127    */
 128   public function __construct($title = NULL, $mode = NULL) {
 129     $this->_name  = CRM_Utils_System::getClassName($this);
 130     $this->_title = $title;
 131     $this->_mode  = $mode;
 132
 133     // let the constructor initialize this, should happen only once
 134     if (!isset(self::$_template)) {
 135       self::$_template = CRM_Core_Smarty::singleton();
 136       self::$_session = CRM_Core_Session::singleton();
 137     }
 138
 139     // FIXME - why are we messing with 'snippet'? Why not just pass it directly into $this->_print?
 140     if (!empty($_REQUEST['snippet'])) {
 141       if ($_REQUEST['snippet'] == CRM_Core_Smarty::PRINT_PDF) {
 142         $this->_print = CRM_Core_Smarty::PRINT_PDF;
 143       }
 144       // FIXME - why does this number not match the constant?
 145       elseif ($_REQUEST['snippet'] == 5) {
 146         $this->_print = CRM_Core_Smarty::PRINT_NOFORM;
 147       }
 148       // Support 'json' as well as legacy value '6'
 149       elseif (in_array($_REQUEST['snippet'], array(CRM_Core_Smarty::PRINT_JSON, 6))) {
 150         $this->_print = CRM_Core_Smarty::PRINT_JSON;
 151       }
 152       else {
 153         $this->_print = CRM_Core_Smarty::PRINT_SNIPPET;
 154       }
 155     }
 156
 157     // if the request has a reset value, initialize the controller session
 158     if (!empty($_REQUEST['reset'])) {
 159       $this->reset();
 160     }
 161   }
 162
 163   /**
 164    * This function takes care of all the things common to all
 165    * pages. This typically involves assigning the appropriate
 166    * smarty variable :)
 167    *
 168    * @return string
 169    *   The content generated by running this page
 170    */
 171   public function run() {
 172     if ($this->_embedded) {
 173       return;
 174     }
 175
 176     self::$_template->assign('mode', $this->_mode);
 177
 178     $pageTemplateFile = $this->getHookedTemplateFileName();
 179     self::$_template->assign('tplFile', $pageTemplateFile);
 180
 181     // invoke the pagRun hook, CRM-3906
 182     CRM_Utils_Hook::pageRun($this);
 183
 184     if ($this->_print) {
 185       if (in_array( $this->_print, array( CRM_Core_Smarty::PRINT_SNIPPET,
 186         CRM_Core_Smarty::PRINT_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON ))) {
 187         $content = self::$_template->fetch('CRM/common/snippet.tpl');
 188       }
 189       else {
 190         $content = self::$_template->fetch('CRM/common/print.tpl');
 191       }
 192
 193       CRM_Utils_System::appendTPLFile($pageTemplateFile,
 194         $content,
 195         $this->overrideExtraTemplateFileName()
 196       );
 197
 198       //its time to call the hook.
 199       CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 200
 201       if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
 202         CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE,
 203           array('paper_size' => 'a3', 'orientation' => 'landscape')
 204         );
 205       }
 206       elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
 207         $this->ajaxResponse['content'] = $content;
 208         CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 209       }
 210       else {
 211         echo $content;
 212       }
 213       CRM_Utils_System::civiExit();
 214     }
 215
 216     $config = CRM_Core_Config::singleton();
 217
 218     // Version check and intermittent alert to admins
 219     CRM_Utils_VersionCheck::singleton()->versionAlert();
 220     CRM_Utils_Check::singleton()->showPeriodicAlerts();
 221
 222     if ($this->useLivePageJS &&
 223       CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE))
 224     {
 225       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
 226       $this->assign('includeWysiwygEditor', TRUE);
 227     }
 228
 229     $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 230
 231     // Render page header
 232     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 233       CRM_Utils_System::addHTMLHead($region->render(''));
 234     }
 235     CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
 236
 237     //its time to call the hook.
 238     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 239
 240     echo CRM_Utils_System::theme($content, $this->_print);
 241     return;
 242   }
 243
 244   /**
 245    * Store the variable with the value in the form scope
 246    *
 247    * @param  string|array $name  name  of the variable or an assoc array of name/value pairs
 248    * @param  mixed        $value value of the variable if string
 249    *
 250    *
 251    * @return void
 252    *
 253    */
 254   public function set($name, $value = NULL) {
 255     self::$_session->set($name, $value, $this->_name);
 256   }
 257
 258   /**
 259    * Get the variable from the form scope
 260    *
 261    * @param  string name  : name  of the variable
 262    *
 263    *
 264    * @return mixed
 265    *
 266    */
 267   public function get($name) {
 268     return self::$_session->get($name, $this->_name);
 269   }
 270
 271   /**
 272    * Assign value to name in template
 273    *
 274    * @param string $var
 275    * @param mixed $value value of varaible
 276    *
 277    * @return void
 278    */
 279   public function assign($var, $value = NULL) {
 280     self::$_template->assign($var, $value);
 281   }
 282
 283   /**
 284    * Assign value to name in template by reference
 285    *
 286    * @param string $var
 287    * @param mixed $value (reference) value of varaible
 288    *
 289    * @return void
 290    */
 291   public function assign_by_ref($var, &$value) {
 292     self::$_template->assign_by_ref($var, $value);
 293   }
 294
 295   /**
 296    * Appends values to template variables
 297    *
 298    * @param array|string $tpl_var the template variable name(s)
 299    * @param mixed $value the value to append
 300    * @param bool $merge
 301    */
 302   public function append($tpl_var, $value=NULL, $merge=FALSE) {
 303     self::$_template->append($tpl_var, $value, $merge);
 304   }
 305
 306   /**
 307    * Returns an array containing template variables
 308    *
 309    * @param string $name
 310    *
 311    * @return array
 312    */
 313   public function get_template_vars($name=null) {
 314     return self::$_template->get_template_vars($name);
 315   }
 316
 317   /**
 318    * Destroy all the session state of this page.
 319    *
 320    *
 321    * @return void
 322    */
 323   public function reset() {
 324     self::$_session->resetScope($this->_name);
 325   }
 326
 327   /**
 328    * Use the form name to create the tpl file name
 329    *
 330    * @return string
 331    */
 332   public function getTemplateFileName() {
 333     return str_replace('_',
 334       DIRECTORY_SEPARATOR,
 335       CRM_Utils_System::getClassName($this)
 336     ) . '.tpl';
 337   }
 338
 339   /**
 340    * A wrapper for getTemplateFileName that includes calling the hook to
 341    * prevent us from having to copy & paste the logic of calling the hook
 342    */
 343   public function getHookedTemplateFileName() {
 344     $pageTemplateFile = $this->getTemplateFileName();
 345     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
 346     return $pageTemplateFile;
 347   }
 348
 349   /**
 350    * Default extra tpl file basically just replaces .tpl with .extra.tpl
 351    * i.e. we dont override
 352    *
 353    * @return string
 354    */
 355   public function overrideExtraTemplateFileName() {
 356     return NULL;
 357   }
 358
 359   /**
 360    * Setter for embedded
 361    *
 362    * @param boolean $embedded
 363    *
 364    * @return void
 365    */
 366   public function setEmbedded($embedded) {
 367     $this->_embedded = $embedded;
 368   }
 369
 370   /**
 371    * Getter for embedded
 372    *
 373    * @return boolean return the embedded value
 374    */
 375   public function getEmbedded() {
 376     return $this->_embedded;
 377   }
 378
 379   /**
 380    * Setter for print
 381    *
 382    * @param boolean $print
 383    *
 384    * @return void
 385    */
 386   public function setPrint($print) {
 387     $this->_print = $print;
 388   }
 389
 390   /**
 391    * Getter for print
 392    *
 393    * @return boolean return the print value
 394    */
 395   public function getPrint() {
 396     return $this->_print;
 397   }
 398
 399   /**
 400    * @return CRM_Core_Smarty
 401    */
 402   public static function &getTemplate() {
 403     return self::$_template;
 404   }
 405
 406   /**
 407    * @param string $name
 408    *
 409    * @return null
 410    */
 411   public function getVar($name) {
 412     return isset($this->$name) ? $this->$name : NULL;
 413   }
 414
 415   /**
 416    * @param string $name
 417    * @param $value
 418    */
 419   public function setVar($name, $value) {
 420     $this->$name = $value;
 421   }
 422 }