3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * A Page is basically data in a nice pretty format.
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.
47 * The name of the page (auto generated from class name)
54 * The title associated with this page
61 * A page can have multiple modes. (i.e. displays
62 * a different set of data based on the input
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)
74 protected $_embedded = FALSE;
77 * Are we in print mode? if so we need to modify the display
78 * functionality to do a minimal display :)
82 protected $_print = FALSE;
85 * Cache the smarty template for efficiency reasons
87 * @var CRM_Core_Smarty
90 static protected $_template;
93 * Cache the session for efficiency reasons
95 * @var CRM_Core_Session
98 static protected $_session;
101 * What to return to the client if in ajax mode (snippet=json)
105 public $ajaxResponse = array();
108 * Url path used to reach this page
112 public $urlPath = array();
115 * Should crm.livePage.js be added to the page?
118 public $useLivePageJS;
123 * @param string $title title of the page
124 * @param int $mode mode of the page
126 * @return CRM_Core_Page
128 public function __construct($title = NULL, $mode = NULL) {
129 $this->_name
= CRM_Utils_System
::getClassName($this);
130 $this->_title
= $title;
131 $this->_mode
= $mode;
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();
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
;
144 // FIXME - why does this number not match the constant?
145 elseif ($_REQUEST['snippet'] == 5) {
146 $this->_print
= CRM_Core_Smarty
::PRINT_NOFORM
;
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
;
153 $this->_print
= CRM_Core_Smarty
::PRINT_SNIPPET
;
157 // if the request has a reset value, initialize the controller session
158 if (!empty($_REQUEST['reset'])) {
164 * This function takes care of all the things common to all
165 * pages. This typically involves assigning the appropriate
168 * @return string The content generated by running this page
170 public function run() {
171 if ($this->_embedded
) {
175 self
::$_template->assign('mode', $this->_mode
);
177 $pageTemplateFile = $this->getHookedTemplateFileName();
178 self
::$_template->assign('tplFile', $pageTemplateFile);
180 // invoke the pagRun hook, CRM-3906
181 CRM_Utils_Hook
::pageRun($this);
184 if (in_array( $this->_print
, array( CRM_Core_Smarty
::PRINT_SNIPPET
,
185 CRM_Core_Smarty
::PRINT_PDF
, CRM_Core_Smarty
::PRINT_NOFORM
, CRM_Core_Smarty
::PRINT_JSON
))) {
186 $content = self
::$_template->fetch('CRM/common/snippet.tpl');
189 $content = self
::$_template->fetch('CRM/common/print.tpl');
192 CRM_Utils_System
::appendTPLFile($pageTemplateFile,
194 $this->overrideExtraTemplateFileName()
197 //its time to call the hook.
198 CRM_Utils_Hook
::alterContent($content, 'page', $pageTemplateFile, $this);
200 if ($this->_print
== CRM_Core_Smarty
::PRINT_PDF
) {
201 CRM_Utils_PDF_Utils
::html2pdf($content, "{$this->_name}.pdf", FALSE,
202 array('paper_size' => 'a3', 'orientation' => 'landscape')
205 elseif ($this->_print
== CRM_Core_Smarty
::PRINT_JSON
) {
206 $this->ajaxResponse
['content'] = $content;
207 CRM_Core_Page_AJAX
::returnJsonResponse($this->ajaxResponse
);
212 CRM_Utils_System
::civiExit();
215 $config = CRM_Core_Config
::singleton();
217 // Version check and intermittent alert to admins
218 CRM_Utils_VersionCheck
::singleton()->versionAlert();
219 CRM_Utils_Check
::singleton()->showPeriodicAlerts();
221 if ($this->useLivePageJS
&&
222 CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'ajaxPopupsEnabled', NULL, TRUE))
224 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
225 $this->assign('includeWysiwygEditor', TRUE);
228 $content = self
::$_template->fetch('CRM/common/' . strtolower($config->userFramework
) . '.tpl');
230 // Render page header
231 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
232 CRM_Utils_System
::addHTMLHead($region->render(''));
234 CRM_Utils_System
::appendTPLFile($pageTemplateFile, $content);
236 //its time to call the hook.
237 CRM_Utils_Hook
::alterContent($content, 'page', $pageTemplateFile, $this);
239 echo CRM_Utils_System
::theme($content, $this->_print
);
244 * Store the variable with the value in the form scope
246 * @param string|array $name name of the variable or an assoc array of name/value pairs
247 * @param mixed $value value of the variable if string
253 public function set($name, $value = NULL) {
254 self
::$_session->set($name, $value, $this->_name
);
258 * Get the variable from the form scope
260 * @param string name : name of the variable
266 public function get($name) {
267 return self
::$_session->get($name, $this->_name
);
271 * Assign value to name in template
274 * @param mixed $value value of varaible
278 public function assign($var, $value = NULL) {
279 self
::$_template->assign($var, $value);
283 * Assign value to name in template by reference
286 * @param mixed $value (reference) value of varaible
290 public function assign_by_ref($var, &$value) {
291 self
::$_template->assign_by_ref($var, $value);
295 * Appends values to template variables
297 * @param array|string $tpl_var the template variable name(s)
298 * @param mixed $value the value to append
301 public function append($tpl_var, $value=NULL, $merge=FALSE) {
302 self
::$_template->append($tpl_var, $value, $merge);
306 * Returns an array containing template variables
308 * @param string $name
312 public function get_template_vars($name=null) {
313 return self
::$_template->get_template_vars($name);
317 * Destroy all the session state of this page.
322 public function reset() {
323 self
::$_session->resetScope($this->_name
);
327 * Use the form name to create the tpl file name
331 public function getTemplateFileName() {
332 return str_replace('_',
334 CRM_Utils_System
::getClassName($this)
339 * A wrapper for getTemplateFileName that includes calling the hook to
340 * prevent us from having to copy & paste the logic of calling the hook
342 public function getHookedTemplateFileName() {
343 $pageTemplateFile = $this->getTemplateFileName();
344 CRM_Utils_Hook
::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
345 return $pageTemplateFile;
349 * Default extra tpl file basically just replaces .tpl with .extra.tpl
350 * i.e. we dont override
354 public function overrideExtraTemplateFileName() {
359 * Setter for embedded
361 * @param boolean $embedded
365 public function setEmbedded($embedded) {
366 $this->_embedded
= $embedded;
370 * Getter for embedded
372 * @return boolean return the embedded value
374 public function getEmbedded() {
375 return $this->_embedded
;
381 * @param boolean $print
385 public function setPrint($print) {
386 $this->_print
= $print;
392 * @return boolean return the print value
394 public function getPrint() {
395 return $this->_print
;
399 * @return CRM_Core_Smarty
401 public static function &getTemplate() {
402 return self
::$_template;
406 * @param string $name
410 public function getVar($name) {
411 return isset($this->$name) ?
$this->$name : NULL;
415 * @param string $name
418 public function setVar($name, $value) {
419 $this->$name = $value;