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