_name = CRM_Utils_System::getClassName($this);
$this->_title = $title;
$this->_mode = $mode;
// let the constructor initialize this, should happen only once
if (!isset(self::$_template)) {
self::$_template = CRM_Core_Smarty::singleton();
self::$_session = CRM_Core_Session::singleton();
}
// FIXME - why are we messing with 'snippet'? Why not just pass it directly into $this->_print?
if (!empty($_REQUEST['snippet'])) {
if ($_REQUEST['snippet'] == CRM_Core_Smarty::PRINT_PDF) {
$this->_print = CRM_Core_Smarty::PRINT_PDF;
}
// FIXME - why does this number not match the constant?
elseif ($_REQUEST['snippet'] == 5) {
$this->_print = CRM_Core_Smarty::PRINT_NOFORM;
}
// Support 'json' as well as legacy value '6'
elseif (in_array($_REQUEST['snippet'], array(CRM_Core_Smarty::PRINT_JSON, 6))) {
$this->_print = CRM_Core_Smarty::PRINT_JSON;
}
else {
$this->_print = CRM_Core_Smarty::PRINT_SNIPPET;
}
}
// if the request has a reset value, initialize the controller session
if (!empty($_REQUEST['reset'])) {
$this->reset();
}
}
/**
* This function takes care of all the things common to all
* pages. This typically involves assigning the appropriate
* smarty variable :)
*
* @return string The content generated by running this page
*/
function run() {
if ($this->_embedded) {
return;
}
self::$_template->assign('mode', $this->_mode);
$pageTemplateFile = $this->getHookedTemplateFileName();
self::$_template->assign('tplFile', $pageTemplateFile);
// invoke the pagRun hook, CRM-3906
CRM_Utils_Hook::pageRun($this);
if ($this->_print) {
if (in_array( $this->_print, array( CRM_Core_Smarty::PRINT_SNIPPET,
CRM_Core_Smarty::PRINT_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON ))) {
$content = self::$_template->fetch('CRM/common/snippet.tpl');
}
else {
$content = self::$_template->fetch('CRM/common/print.tpl');
}
CRM_Utils_System::appendTPLFile($pageTemplateFile,
$content,
$this->overrideExtraTemplateFileName()
);
//its time to call the hook.
CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE,
array('paper_size' => 'a3', 'orientation' => 'landscape')
);
}
elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
$this->ajaxResponse['content'] = $content;
CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
}
else {
echo $content;
}
CRM_Utils_System::civiExit();
}
$config = CRM_Core_Config::singleton();
// Version check and intermittent alert to admins
CRM_Utils_VersionCheck::singleton()->versionAlert();
CRM_Utils_Check::singleton()->showPeriodicAlerts();
// Debug msg once per hour
if ($config->debug && CRM_Core_Permission::check('administer CiviCRM') && CRM_Core_Session::singleton()->timer('debug_alert', 7200)) {
$msg = ts('Warning: Debug is enabled in system settings. This should not be enabled on production servers.', array(1 => CRM_Utils_System::url('civicrm/admin/setting/debug', 'reset=1')));
CRM_Core_Session::setStatus($msg, ts('Debug Mode'));
}
$mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'mailing_backend');
// Outbound email msg once every 2 hours if outbound email is redirected or disabled
if (($mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB
|| (defined('CIVICRM_MAIL_LOG') && CIVICRM_MAIL_LOG)
|| $mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_DISABLED
|| $mailingInfo['outBound_option'] == CRM_Mailing_Config::OUTBOUND_OPTION_MOCK)
&& CRM_Core_Permission::check('administer CiviCRM') && CRM_Core_Session::singleton()->timer('outboundEmail_alert', 7200))
{
$msg = ts('Warning: Outbound email is disabled in system settings. Proper settings should be enabled on production servers.', array(1 => CRM_Utils_System::url('civicrm/admin/setting/smtp', 'reset=1')));
CRM_Core_Session::setStatus($msg, ts('Outbound Email Settings'));
}
if ($this->useLivePageJS &&
CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajaxPopupsEnabled', NULL, TRUE))
{
CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js');
$this->assign('includeWysiwygEditor', TRUE);
}
$content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
// Render page header
if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
CRM_Utils_System::addHTMLHead($region->render(''));
}
CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
//its time to call the hook.
CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
echo CRM_Utils_System::theme($content, $this->_print);
return;
}
/**
* Store the variable with the value in the form scope
*
* @param string|array $name name of the variable or an assoc array of name/value pairs
* @param mixed $value value of the variable if string
*
* @access public
*
* @return void
*
*/
function set($name, $value = NULL) {
self::$_session->set($name, $value, $this->_name);
}
/**
* Get the variable from the form scope
*
* @param string name : name of the variable
*
* @access public
*
* @return mixed
*
*/
function get($name) {
return self::$_session->get($name, $this->_name);
}
/**
* assign value to name in template
*
* @param $var
* @param mixed $value value of varaible
*
* @internal param array|string $name name of variable
* @return void
* @access public
*/
function assign($var, $value = NULL) {
self::$_template->assign($var, $value);
}
/**
* assign value to name in template by reference
*
* @param array|string $name name of variable
* @param mixed $value (reference) value of varaible
*
* @return void
* @access public
*/
function assign_by_ref($var, &$value) {
self::$_template->assign_by_ref($var, $value);
}
/**
* appends values to template variables
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
* @param bool $merge
*/
function append($tpl_var, $value=NULL, $merge=FALSE) {
self::$_template->append($tpl_var, $value, $merge);
}
/**
* Returns an array containing template variables
*
* @param string $name
*
* @internal param string $type
* @return array
*/
function get_template_vars($name=null) {
return self::$_template->get_template_vars($name);
}
/**
* function to destroy all the session state of this page.
*
* @access public
*
* @return void
*/
function reset() {
self::$_session->resetScope($this->_name);
}
/**
* Use the form name to create the tpl file name
*
* @return string
* @access public
*/
function getTemplateFileName() {
return str_replace('_',
DIRECTORY_SEPARATOR,
CRM_Utils_System::getClassName($this)
) . '.tpl';
}
/**
* A wrapper for getTemplateFileName that includes calling the hook to
* prevent us from having to copy & paste the logic of calling the hook
*/
function getHookedTemplateFileName() {
$pageTemplateFile = $this->getTemplateFileName();
CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
return $pageTemplateFile;
}
/**
* Default extra tpl file basically just replaces .tpl with .extra.tpl
* i.e. we dont override
*
* @return string
* @access public
*/
function overrideExtraTemplateFileName() {
return NULL;
}
/**
* setter for embedded
*
* @param boolean $embedded
*
* @return void
* @access public
*/
function setEmbedded($embedded) {
$this->_embedded = $embedded;
}
/**
* getter for embedded
*
* @return boolean return the embedded value
* @access public
*/
function getEmbedded() {
return $this->_embedded;
}
/**
* setter for print
*
* @param boolean $print
*
* @return void
* @access public
*/
function setPrint($print) {
$this->_print = $print;
}
/**
* getter for print
*
* @return boolean return the print value
* @access public
*/
function getPrint() {
return $this->_print;
}
static function &getTemplate() {
return self::$_template;
}
function getVar($name) {
return isset($this->$name) ? $this->$name : NULL;
}
function setVar($name, $value) {
$this->$name = $value;
}
}