CRM/Core/Page.php

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