<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
*/
static protected $_session;
+ /**
+ * What to return to the client if in ajax mode (snippet=json)
+ *
+ * @var array
+ */
+ public $ajaxResponse = array();
+
+ /**
+ * Url path used to reach this page
+ *
+ * @var array
+ */
+ public $urlPath = array();
+
+ /**
+ * Should crm.livePage.js be added to the page?
+ * @var bool
+ */
+ public $useLivePageJS;
+
/**
* class constructor
*
self::$_session = CRM_Core_Session::singleton();
}
- if (isset($_REQUEST['snippet']) && $_REQUEST['snippet']) {
- if ($_REQUEST['snippet'] == 3) {
+ // 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;
}
- else if ($_REQUEST['snippet'] == 5) {
+ // 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 (CRM_Utils_Array::value('reset', $_REQUEST)) {
+ if (!empty($_REQUEST['reset'])) {
$this->reset();
}
}
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_PDF, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON ))) {
$content = self::$_template->fetch('CRM/common/snippet.tpl');
}
else {
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;
}
$config = CRM_Core_Config::singleton();
- // TODO: Is there a better way to ensure these actions don't happen during AJAX requests?
- if (empty($_GET['snippet'])) {
- // Version check and intermittent alert to admins
- CRM_Utils_VersionCheck::singleton()->versionAlert();
- CRM_Utils_Check_Security::singleton()->showPeriodicAlerts();
+ // 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', 3600)) {
- $msg = ts('Warning: Debug is enabled in <a href="%1">system settings</a>. 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'));
- }
+ 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');
/**
* assign value to name in template
*
- * @param array|string $name name of variable
+ * @param $var
* @param mixed $value value of varaible
*
+ * @internal param array|string $name name of variable
* @return void
* @access public
*/
/**
* assign value to name in template by reference
*
- * @param array|string $name name of variable
+ * @param $var
* @param mixed $value (reference) value of varaible
*
+ * @internal param array|string $name name of variable
* @return void
* @access public
*/
* Returns an array containing template variables
*
* @param string $name
- * @param string $type
+ *
+ * @internal param string $type
* @return array
*/
function get_template_vars($name=null) {