File Source for OCSP_CMS_HTMLPAGE.phpclass

<?php
/**
* Class file OCSP_CMS_HTMLPAGE.phpclass
*
* @project Open CSP-Management
* @package cms
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-06-07
*
* @requires __OCSP_PHPINCPATH__."common/OCSP_HTMLPAGE.phpclass";
*
* @uses _OCSP_PEARPATH_
*
* @see http://pear.php.net/manual/en/package.caching.cache-lite.php
***/
/**
* ---------------------------------------------------
*
* common settings and requirements
*
*/
if (!defined('__OCSP_CMS_PHPINCPATH__'))
{
require_once __OCSP_DEFAULTCONFPATH__."cms.conf.phpinc";
}
pcf_require_class('OCSP_HTMLPAGE',"common/");
pcf_require_class('CMS_TABLEOBJ',"cms/");
pcf_require_class('CMS_PROJECT',"cms/");
pcf_require_class('CMS_PAGE',"cms/page/");
/**
* Class OCSP_CMS_PEARCACHE.phpclass
*
* @project Open CSP-Management
* @package cms
*
* @author Peter Krebs <p.krebs@amicas.at>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-06-07
*
*/
class OCSP_CMS_HTMLPAGE extends OCSP_HTMLPAGE
{
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/**
* unit of work array of instances
*
* @staticvar array $myCMSPageInstances
*/
protected static $loaded_CMS_HTML_Pages = array();
/*** class methods ------------------------------------------------ */
/**
* returns the current html page object
*
* @return CMS_PAGE
*/
public static function &getCurrentPage($debug)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_CMS_HTMLPAGE::getCurrentPage()");
if (!$obj_page = CMS_TABLEOBJ::get_currentPage())
{
if (!$obj_menu = CMS_TABLEOBJ::get_currentMenu())
{
if (!$obj_project = CMS_TABLEOBJ::get_currentProj())
{
throw new Exception("COULD NOT FIND SOMETHING TO SHOW");
}
$obj_menu = $obj_project->getCurrentMenuNode();
}
$obj_page = $obj_menu->getCurrentPage(False,True);
CMS_TABLEOBJ::set_currentPage($obj_page);
}
return $obj_page;
}
/**
* returns if a page is already instanced
*
* @param int $aPageId
* @return boolean
*/
public static function isInstanced($aPageId)
{
return isset(self::$loaded_CMS_HTML_Pages[intval($aPageId)]);
}
/**
* returns the instance for $aPage
*
* NOTE you can pass either the pageId or the page object
*
* @param mixed $aPage
* @param boolean $debug
*
* @return OCSP_CMS_HTMLPAGE
*/
public static function &getInstance($aPage,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_CMS_HTMLPAGE::getInstance()");
if (!pcf_class_implements($aPage,'INFA_CMS_PAGE'))
{
if ($int_pagId = intval($aPage))
{
if (isset(self::$loaded_CMS_HTML_Pages[$int_pagId]) && pcf_is_instance_of(self::$loaded_CMS_HTML_Pages[$int_pagId],'OCSP_CMS_HTMLPAGE'))
{
return self::$loaded_CMS_HTML_Pages[$int_pagId];
} else {
if (!($aPage = CMS_PAGE::getInstance($int_pagId)))
{
$obj_ret = Null;
return $obj_ret;
}
}
} else {
$obj_ret = Null;
return $obj_ret;
}
}
$int_pagId = $aPage->getId();
if (isset(self::$loaded_CMS_HTML_Pages[$int_pagId]) && pcf_is_instance_of(self::$loaded_CMS_HTML_Pages[$int_pagId],'OCSP_CMS_HTMLPAGE'))
{
return self::$loaded_CMS_HTML_Pages[$int_pagId];
} else {
self::$loaded_CMS_HTML_Pages[$int_pagId] = new OCSP_CMS_HTMLPAGE($aPage,$debug);
return self::$loaded_CMS_HTML_Pages[$int_pagId];
}
}
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* @var CMS_PAGE $myPageObj
* @access protected
*/
protected $myPageObj=Null;
/**
* @var CMS_MENU_NODE $myPageObj
* @access protected
*/
protected $myMenuNode=Null;
/**
* @var CMS_PROJECT $myProject
*/
protected $myProject=Null;
/*** attributes -------------------------------------------------- */
/**
* @var string $myJsOnError
* @access protectd
*/
protected $myJsOnError="
window.onerror=ocsp_handleErr;
var ocsp_handleErrDebug=true;
function ocsp_handleErr(msg,url,l)
{
var txt=\"\";
txt =\"There was an error on this page.\\n\\n\";
txt+=\"Error: \" + msg + \"\\n\";
txt+=\"URL: \" + url + \"\\n\";
txt+=\"Line: \" + l + \"\\n\\n\";
txt+=\"Click OK to continue.\\n\\n\";
if (ocsp_handleErrDebug) alert(txt);
return true;
}
";
/**
* preview mode
*
* @var boolean
*/
protected $previewMode = False;
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* factories the html page from the environment
*
* @param boolean $debug
*
* @return OCSP_CMS_HTMLPAGE
*
* @since pk-08-11-30
*/
public static function &factoryFromEnv($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_CMS_HTMLPAGE::factoryFromEnv");
if (CMS_TABLEOBJ::factoryCurrentElements($debug))
{
try {
$obj_page = self::getCurrentPage($debug);
} catch(Exception $e) {
if ($debug) {
ob_start();
var_dump($e);
$str_debug = ob_get_contents();
ob_end_clean();
echoDebugLine(__FILE__,__LINE__,$str_debug);
}
$obj_page = new CMS_PAGE();
$obj_page->setMyProject(CMS_TABLEOBJ::get_currentProj());
$obj_page->setMyMenuNode(CMS_TABLEOBJ::get_currentMenu());
}
$obj_ret = self::getInstance($obj_page);
} else {
$obj_page=Null;
$obj_ret = new OCSP_CMS_HTMLPAGE($obj_page,$debug);
}
if (isset($_GET['PREVIEW']) && intval($_GET['PREVIEW']))
{
$obj_ret->setPreviewMode(True);
}
return $obj_ret;
}
/**
* factories a html page from a cms page object
*
* @param CMS_PAGE $aPage
* @param boolean $debug
*
* @return OCSP_CMS_HTMLPAGE
*/
public static function factoryFromPage(&$aPage,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","OCSP_CMS_HTMLPAGE::factoryFromPage()");
if (!pcf_class_implements($aPage,'INFA_CMS_PAGE'))
{
return Null;
}
return new OCSP_CMS_HTMLPAGE($aPage,$debug);
}
/**
* @param CMS_PAGE_V2 $aPage
* @param boolean $debug
*/
function OCSP_CMS_HTMLPAGE(&$aPage,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE");
parent::OCSP_HTMLPAGE($debug);
if (pcf_class_implements($aPage,"INFA_CMS_PAGE"))
{
$this->myPageObj =$aPage;
$this->myMenuNode =$aPage->getMyMenuNode($debug);
$this->myProject =$aPage->getMyProject($debug);
if (intval($this->myPageObj->getId()))
{
$this->populateHTML_Head($debug);
}
$this->myPageObj->setMyHTMLPage($this);
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"<h1>WARNING: no page set</h1><p>" . get_class($aPage) . "</p>");
}
}
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* returns the page object
*
* @return CMS_PAGE
*/
public function getPageObj()
{
return $this->myPageObj;
}
/**
* returns if preview is on
*
* @return boolean
*/
public function getPreviewMode()
{
return $this->previewMode;
}
/**
* sets preview mode
*
* @param boolean $on
*/
public function setPreviewMode($on=True)
{
$this->previewMode = $on;
}
/** -----------------------------------------------------
* body content
*/
/**
* adds a body content (to a block)
*
* if the blockname ends with [] the content is treaten as array
* in this case prepend is disabled
*
* @param CMS_PAGE_V2 $aPage
* @param int $chapterMode
* @param boolean $prepend
* @param string $blockName
* @param boolean $debug
* @access public
*
* @todo OCSP_HTMLPAGE::prepend in array mode
*
*/
function addBodyContentPage($aPage,$chapterMode=0,$prepend=False,$blockName='DEFAULT',$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE::addPageContent()");
if (!pcf_class_implements($aPage,"INFA_CMS_PAGE"))
{
ocsp_logError(__FILE__,__LINE__,"addPageContent(): \$aPage (".get_class($aPage).") is not an instance of CMS_PAGE_V2",E_WARNING);
} else {
$aPage->execPrependCmds($debug);
$aPage->setMyHTMLPage($this);
$str_content=$aPage->getContent($chapterMode,$debug);
if ($debug) echoDebugLine(__FILE__,__LINE__,"<h1>OCSP_CMS_HTMLPAGE::pageContent: </h1><pre>".htmlspecialchars($str_content)."</pre>");
$this->addBodyContent($str_content,$prepend,$blockName);
}
}
/** -----------------------------------------------------
* cache methods
*/
/**
* returns if the cms cache is usable
*
* if (_OCSP_USEPEARCACHE_) it's ensured that
* $GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE'] is an object
*
* @return boolean
*/
function cmsCacheIsUsable()
{
if (_OCSP_USEPEARCACHE_) {
if (!pcf_is_instance_of($GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE'],'OCSP_CMS_PEARCACHE'))
{
require_once $GLOBALS['OCSP_CMS']['PHPINCPATH']."OCSP_CMS_PEARCACHE.phpclass";
$GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE']=new OCSP_CMS_PEARCACHE();
}
$this->myCmsCache=&$GLOBALS['OCSP_OBJ']['CMS_PEARCHACHE'];
return TRUE;
}
return False;
}
/**
* HTML head ----------------------------------------------------------------------------------
*/
/**
* sets the html header form the page
* note clears all previous settings
*
* @param boolean $debug
*
* @return boolean
* @access public
*
*/
function populateHTML_Head($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE::populateHTML_Head()");
if (!pcf_is_instance_of($this->myPageObj,'CMS_PAGE_V2')) {
if ($debug) echoDebugLine(__FILE__,__LINE__,"No page object set");
return False;
}
$this->setTitle($this->myPageObj->getTitle());
// css
if (!isset($GLOBALS['OCSP_VAL']['CMS_CSS_STY_INCLUDED']))
{
$GLOBALS['OCSP_VAL']['CMS_CSS_STY_INCLUDED']=array();
}
if (pcf_is_instance_of($this->myProject,'CMS_PROJECT'))
{
$this->myProject->addCssToHTMLPage($this,$debug);
}
}
// ------------------------------------------------
// output
// ------------------------------------------------
/**
* loads the required templates and sets the template vars
*
* @param unknown_type $debug
*/
public function prepare($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE::prepare");
if ($str_idxTmpl=CMS_TABLEOBJ::get_currentProj()->getIndexPHP_inc($debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"index template: ".$str_idxTmpl);
if (!$debug) {
ob_start();
include $str_idxTmpl;
$this->addBodyContent(ob_get_contents());
ob_end_clean();
} else {
include $str_idxTmpl;
}
}
}
/**
* outputs the page
*
* @param boolean $closeBody
* @param string $convertCharSet
*
* @version pk-07-12-14 gzip return
*/
function display($closeBody=true,$convertCharSet="UTF-8",$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE::display();");
if (pcf_class_implements($this->myPageObj,'INFA_CMS_PAGE'))
{
if (!is_array($this->myTemplateVars['ALL'])) $this->myTemplateVars['ALL']=array();
$this->myTemplateVars['ALL'] = array_merge($this->myPageObj->getDBVal(),$this->myTemplateVars['ALL']);
$this->myTemplateVars['ALL'] = array_merge($this->myPageObj->getMyMenuNode()->getDBVal(),$this->myTemplateVars['ALL']);
$this->myTemplateVars['ALL'] = array_merge($this->myPageObj->getMyProject()->getDBVal(),$this->myTemplateVars['ALL']);
if (!$this->myPageObj->getContentCalled())
{
$this->setTemplateVar('PAGECONTENT',$this->myPageObj->getContent(0,$debug));
}
}
if ($debug) {
echoDebugLine(__FILE__,__LINE__,"<h2>Content:</h2><pre>" . htmlspecialchars(print_r($this->myBodyContent,True)) . "</pre>");
echoDebugLine(__FILE__,__LINE__,"<h2>myTemplateVars:</h2><pre>" . htmlspecialchars(print_r($this->myTemplateVars,True)) . "</pre>");
}
parent::display($closeBody,$convertCharSet);
}
/**
* outputs an error page
*
* @param string $errorMsg
*
* @todo make layout
*/
public function displayErrorPage($errorMsg)
{
echo "
<html>
<head>
<title>" . t_admin("Fehler") . "</title>
</head>
<body>
<h1>" . t_admin("Fehler") . "</h1>
<p>{$errorMsg}</p>
</body>
</html>
";
}
// ------------------------------------------------
// view / rights
// ------------------------------------------------
/**
* returns if the current user can open the page
*
* @param boolean $debug
*
* @return boolean
*/
public function curUserCanOpen($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_CMS_HTMLPAGE::curUserCanOpen()");
if (pcf_class_implements($this->getPageObj(),"INFA_CMS_PAGE"))
{
if (!$this->getPreviewMode())
{
if (!$this->getPageObj()->isOnline())
{
return False;
}
}
return $this->getPageObj()->curUserCanOpen();
} else {
return False;
}
}
} // end class OCSP_CMS_HTMLPAGE

Source for file OCSP_CMS_HTMLPAGE.phpclass