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
 124    *   Title of the page.
 125    * @param int $mode
 126    *   Mode of the page.
 127    *
 128    * @return CRM_Core_Page
 129    */
 130   public function __construct($title = NULL, $mode = NULL) {
 131     $this->_name  = CRM_Utils_System::getClassName($this);
 132     $this->_title = $title;
 133     $this->_mode  = $mode;
 134
 135     // let the constructor initialize this, should happen only once
 136     if (!isset(self::$_template)) {
 137       self::$_template = CRM_Core_Smarty::singleton();
 138       self::$_session = CRM_Core_Session::singleton();
 139     }
 140
 141     // FIXME - why are we messing with 'snippet'? Why not just pass it directly into $this->_print?
 142     if (!empty($_REQUEST['snippet'])) {
 143       if ($_REQUEST['snippet'] == CRM_Core_Smarty::PRINT_PDF) {
 144         $this->_print = CRM_Core_Smarty::PRINT_PDF;
 145       }
 146       // FIXME - why does this number not match the constant?
 147       elseif ($_REQUEST['snippet'] == 5) {
 148         $this->_print = CRM_Core_Smarty::PRINT_NOFORM;
 149       }
 150       // Support 'json' as well as legacy value '6'
 151       elseif (in_array($_REQUEST['snippet'], array(CRM_Core_Smarty::PRINT_JSON, 6))) {
 152         $this->_print = CRM_Core_Smarty::PRINT_JSON;
 153       }
 154       else {
 155         $this->_print = CRM_Core_Smarty::PRINT_SNIPPET;
 156       }
 157     }
 158
 159     // if the request has a reset value, initialize the controller session
 160     if (!empty($_REQUEST['reset'])) {
 161       $this->reset();
 162     }
 163   }
 164
 165   /**
 166    * This function takes care of all the things common to all
 167    * pages. This typically involves assigning the appropriate
 168    * smarty variable :)
 169    *
 170    * @return string
 171    *   The content generated by running this page
 172    */
 173   public function run() {
 174     if ($this->_embedded) {
 175       return;
 176     }
 177
 178     self::$_template->assign('mode', $this->_mode);
 179
 180     $pageTemplateFile = $this->getHookedTemplateFileName();
 181     self::$_template->assign('tplFile', $pageTemplateFile);
 182
 183     // invoke the pagRun hook, CRM-3906
 184     CRM_Utils_Hook::pageRun($this);
 185
 186     if ($this->_print) {
 187       if (in_array($this->_print, array(CRM_Core_Smarty::PRINT_SNIPPET,
 188         CRM_Core_Smarty::PRINT_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON))) {
 189         $content = self::$_template->fetch('CRM/common/snippet.tpl');
 190       }
 191       else {
 192         $content = self::$_template->fetch('CRM/common/print.tpl');
 193       }
 194
 195       CRM_Utils_System::appendTPLFile($pageTemplateFile,
 196         $content,
 197         $this->overrideExtraTemplateFileName()
 198       );
 199
 200       //its time to call the hook.
 201       CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 202
 203       if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
 204         CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE,
 205           array('paper_size' => 'a3', 'orientation' => 'landscape')
 206         );
 207       }
 208       elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
 209         $this->ajaxResponse['content'] = $content;
 210         CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 211       }
 212       else {
 213         echo $content;
 214       }
 215       CRM_Utils_System::civiExit();
 216     }
 217
 218     $config = CRM_Core_Config::singleton();
 219
 220     // Version check and intermittent alert to admins
 221     CRM_Utils_VersionCheck::singleton()->versionAlert();
 222     CRM_Utils_Check::singleton()->showPeriodicAlerts();
 223
 224     if ($this->useLivePageJS &&
 225       CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE))
 226     {
 227       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
 228       $this->assign('includeWysiwygEditor', TRUE);
 229     }
 230
 231     $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 232
 233     // Render page header
 234     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 235       CRM_Utils_System::addHTMLHead($region->render(''));
 236     }
 237     CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
 238
 239     //its time to call the hook.
 240     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 241
 242     echo CRM_Utils_System::theme($content, $this->_print);
 243     return;
 244   }
 245
 246   /**
 247    * Store the variable with the value in the form scope
 248    *
 249    * @param string|array $name name of the variable or an assoc array of name/value pairs
 250    * @param mixed $value
 251    *   Value of the variable if string.
 252    *
 253    *
 254    * @return void
 255    *
 256    */
 257   public function set($name, $value = NULL) {
 258     self::$_session->set($name, $value, $this->_name);
 259   }
 260
 261   /**
 262    * Get the variable from the form scope
 263    *
 264    * @param string name : name of the variable
 265    *
 266    *
 267    * @return mixed
 268    *
 269    */
 270   public function get($name) {
 271     return self::$_session->get($name, $this->_name);
 272   }
 273
 274   /**
 275    * Assign value to name in template
 276    *
 277    * @param string $var
 278    * @param mixed $value
 279    *   Value of varaible.
 280    *
 281    * @return void
 282    */
 283   public function assign($var, $value = NULL) {
 284     self::$_template->assign($var, $value);
 285   }
 286
 287   /**
 288    * Assign value to name in template by reference
 289    *
 290    * @param string $var
 291    * @param mixed $value
 292    *   (reference) value of varaible.
 293    *
 294    * @return void
 295    */
 296   public function assign_by_ref($var, &$value) {
 297     self::$_template->assign_by_ref($var, $value);
 298   }
 299
 300   /**
 301    * Appends values to template variables
 302    *
 303    * @param array|string $tpl_var the template variable name(s)
 304    * @param mixed $value
 305    *   The value to append.
 306    * @param bool $merge
 307    */
 308   public function append($tpl_var, $value = NULL, $merge = FALSE) {
 309     self::$_template->append($tpl_var, $value, $merge);
 310   }
 311
 312   /**
 313    * Returns an array containing template variables
 314    *
 315    * @param string $name
 316    *
 317    * @return array
 318    */
 319   public function get_template_vars($name = NULL) {
 320     return self::$_template->get_template_vars($name);
 321   }
 322
 323   /**
 324    * Destroy all the session state of this page.
 325    *
 326    *
 327    * @return void
 328    */
 329   public function reset() {
 330     self::$_session->resetScope($this->_name);
 331   }
 332
 333   /**
 334    * Use the form name to create the tpl file name
 335    *
 336    * @return string
 337    */
 338   public function getTemplateFileName() {
 339     return str_replace('_',
 340       DIRECTORY_SEPARATOR,
 341       CRM_Utils_System::getClassName($this)
 342     ) . '.tpl';
 343   }
 344
 345   /**
 346    * A wrapper for getTemplateFileName that includes calling the hook to
 347    * prevent us from having to copy & paste the logic of calling the hook
 348    */
 349   public function getHookedTemplateFileName() {
 350     $pageTemplateFile = $this->getTemplateFileName();
 351     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
 352     return $pageTemplateFile;
 353   }
 354
 355   /**
 356    * Default extra tpl file basically just replaces .tpl with .extra.tpl
 357    * i.e. we dont override
 358    *
 359    * @return string
 360    */
 361   public function overrideExtraTemplateFileName() {
 362     return NULL;
 363   }
 364
 365   /**
 366    * Setter for embedded
 367    *
 368    * @param bool $embedded
 369    *
 370    * @return void
 371    */
 372   public function setEmbedded($embedded) {
 373     $this->_embedded = $embedded;
 374   }
 375
 376   /**
 377    * Getter for embedded
 378    *
 379    * @return boolean return the embedded value
 380    */
 381   public function getEmbedded() {
 382     return $this->_embedded;
 383   }
 384
 385   /**
 386    * Setter for print
 387    *
 388    * @param bool $print
 389    *
 390    * @return void
 391    */
 392   public function setPrint($print) {
 393     $this->_print = $print;
 394   }
 395
 396   /**
 397    * Getter for print
 398    *
 399    * @return boolean return the print value
 400    */
 401   public function getPrint() {
 402     return $this->_print;
 403   }
 404
 405   /**
 406    * @return CRM_Core_Smarty
 407    */
 408   public static function &getTemplate() {
 409     return self::$_template;
 410   }
 411
 412   /**
 413    * @param string $name
 414    *
 415    * @return null
 416    */
 417   public function getVar($name) {
 418     return isset($this->$name) ? $this->$name : NULL;
 419   }
 420
 421   /**
 422    * @param string $name
 423    * @param $value
 424    */
 425   public function setVar($name, $value) {
 426     $this->$name = $value;
 427   }
 428 }