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    */
  89   static protected $_template;
  90
  91   /**
  92    * Cache the session for efficiency reasons
  93    *
  94    * @var CRM_Core_Session
  95    */
  96   static protected $_session;
  97
  98   /**
  99    * What to return to the client if in ajax mode (snippet=json)
 100    *
 101    * @var array
 102    */
 103   public $ajaxResponse = array();
 104
 105   /**
 106    * Url path used to reach this page
 107    *
 108    * @var array
 109    */
 110   public $urlPath = array();
 111
 112   /**
 113    * Should crm.livePage.js be added to the page?
 114    * @var bool
 115    */
 116   public $useLivePageJS;
 117
 118   /**
 119    * Class constructor
 120    *
 121    * @param string $title
 122    *   Title of the page.
 123    * @param int $mode
 124    *   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   public function run() {
 169     if ($this->_embedded) {
 170       return;
 171     }
 172
 173     self::$_template->assign('mode', $this->_mode);
 174
 175     $pageTemplateFile = $this->getHookedTemplateFileName();
 176     self::$_template->assign('tplFile', $pageTemplateFile);
 177
 178     // invoke the pagRun hook, CRM-3906
 179     CRM_Utils_Hook::pageRun($this);
 180
 181     if ($this->_print) {
 182       if (in_array($this->_print, array(
 183         CRM_Core_Smarty::PRINT_SNIPPET,
 184         CRM_Core_Smarty::PRINT_PDF,
 185         CRM_Core_Smarty::PRINT_NOFORM,
 186         CRM_Core_Smarty::PRINT_JSON
 187       ))) {
 188         $content = self::$_template->fetch('CRM/common/snippet.tpl');
 189       }
 190       else {
 191         $content = self::$_template->fetch('CRM/common/print.tpl');
 192       }
 193
 194       CRM_Utils_System::appendTPLFile($pageTemplateFile,
 195         $content,
 196         $this->overrideExtraTemplateFileName()
 197       );
 198
 199       //its time to call the hook.
 200       CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 201
 202       if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
 203         CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE,
 204           array('paper_size' => 'a3', 'orientation' => 'landscape')
 205         );
 206       }
 207       elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
 208         $this->ajaxResponse['content'] = $content;
 209         CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 210       }
 211       else {
 212         echo $content;
 213       }
 214       CRM_Utils_System::civiExit();
 215     }
 216
 217     $config = CRM_Core_Config::singleton();
 218
 219     // Version check and intermittent alert to admins
 220     CRM_Utils_VersionCheck::singleton()->versionAlert();
 221     CRM_Utils_Check::singleton()->showPeriodicAlerts();
 222
 223     if ($this->useLivePageJS &&
 224       CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE)
 225     ) {
 226       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
 227       $this->assign('includeWysiwygEditor', TRUE);
 228     }
 229
 230     $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 231
 232     // Render page header
 233     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 234       CRM_Utils_System::addHTMLHead($region->render(''));
 235     }
 236     CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
 237
 238     //its time to call the hook.
 239     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 240
 241     echo CRM_Utils_System::theme($content, $this->_print);
 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
 249    *   Value of the variable if string.
 250    *
 251    *
 252    * @return void
 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   public function get($name) {
 267     return self::$_session->get($name, $this->_name);
 268   }
 269
 270   /**
 271    * Assign value to name in template
 272    *
 273    * @param string $var
 274    * @param mixed $value
 275    *   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
 288    *   (reference) value of varaible.
 289    *
 290    * @return void
 291    */
 292   public function assign_by_ref($var, &$value) {
 293     self::$_template->assign_by_ref($var, $value);
 294   }
 295
 296   /**
 297    * Appends values to template variables
 298    *
 299    * @param array|string $tpl_var the template variable name(s)
 300    * @param mixed $value
 301    *   The value to append.
 302    * @param bool $merge
 303    */
 304   public function append($tpl_var, $value = NULL, $merge = FALSE) {
 305     self::$_template->append($tpl_var, $value, $merge);
 306   }
 307
 308   /**
 309    * Returns an array containing template variables
 310    *
 311    * @param string $name
 312    *
 313    * @return array
 314    */
 315   public function get_template_vars($name = NULL) {
 316     return self::$_template->get_template_vars($name);
 317   }
 318
 319   /**
 320    * Destroy all the session state of this page.
 321    *
 322    *
 323    * @return void
 324    */
 325   public function reset() {
 326     self::$_session->resetScope($this->_name);
 327   }
 328
 329   /**
 330    * Use the form name to create the tpl file name
 331    *
 332    * @return string
 333    */
 334   public function getTemplateFileName() {
 335     return str_replace('_',
 336       DIRECTORY_SEPARATOR,
 337       CRM_Utils_System::getClassName($this)
 338     ) . '.tpl';
 339   }
 340
 341   /**
 342    * A wrapper for getTemplateFileName that includes calling the hook to
 343    * prevent us from having to copy & paste the logic of calling the hook
 344    */
 345   public function getHookedTemplateFileName() {
 346     $pageTemplateFile = $this->getTemplateFileName();
 347     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
 348     return $pageTemplateFile;
 349   }
 350
 351   /**
 352    * Default extra tpl file basically just replaces .tpl with .extra.tpl
 353    * i.e. we dont override
 354    *
 355    * @return string
 356    */
 357   public function overrideExtraTemplateFileName() {
 358     return NULL;
 359   }
 360
 361   /**
 362    * Setter for embedded
 363    *
 364    * @param bool $embedded
 365    *
 366    * @return void
 367    */
 368   public function setEmbedded($embedded) {
 369     $this->_embedded = $embedded;
 370   }
 371
 372   /**
 373    * Getter for embedded
 374    *
 375    * @return boolean
 376    *   return the embedded value
 377    */
 378   public function getEmbedded() {
 379     return $this->_embedded;
 380   }
 381
 382   /**
 383    * Setter for print
 384    *
 385    * @param bool $print
 386    *
 387    * @return void
 388    */
 389   public function setPrint($print) {
 390     $this->_print = $print;
 391   }
 392
 393   /**
 394    * Getter for print
 395    *
 396    * @return boolean
 397    *   return the print value
 398    */
 399   public function getPrint() {
 400     return $this->_print;
 401   }
 402
 403   /**
 404    * @return CRM_Core_Smarty
 405    */
 406   public static function &getTemplate() {
 407     return self::$_template;
 408   }
 409
 410   /**
 411    * @param string $name
 412    *
 413    * @return null
 414    */
 415   public function getVar($name) {
 416     return isset($this->$name) ? $this->$name : NULL;
 417   }
 418
 419   /**
 420    * @param string $name
 421    * @param $value
 422    */
 423   public function setVar($name, $value) {
 424     $this->$name = $value;
 425   }
 426 }