File Source for OCSP_HTMLPAGE.phpclass

<?php
/**
* Class file OCSP_HTMLPAGE.phpclass
*
* @project Open CSP-Management
* @package common
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-04-16
* @version $Id: OCSP_HTMLPAGE.phpclass,v 1.27 2008/12/10 15:39:05 peterkrebs Exp $
*
*/
/**
* ---------------------------------------------------
*
* common settings and requirements
*
*/
pcf_require_class('OCSP_TRANSLATOR',dirname(__FILE__) . _OCSP_DIRSEP_ . "OCSP_TRANSLATOR.phpclass");
pcf_require_class('OCSP_BROWSER',dirname(__FILE__) . "/");
pcf_require_class('OCSP_TEMPLATE',"common/");
require_once dirname(__FILE__) . _OCSP_DIRSEP_ . "pcf.phpinc";
require_once dirname(__FILE__) . _OCSP_DIRSEP_ . "pcf_templates.phpinc";
/** ---------------------------------------------------
* Class OCSP_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-04-16
*
* @version $Id: OCSP_HTMLPAGE.phpclass,v 1.27 2008/12/10 15:39:05 peterkrebs Exp $
*
* @desc buffers a html page
*
*/
class OCSP_HTMLPAGE {
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/*** class methods --------------------------------------------------- */
/**
* if $name is in URIs Query string the value
* is replaced otherwise $name=$value is appended to the uri
*
* @param string $uri
* @param string $name
* @param string $value
* @param boolean $debug
*
* @return string
*
* @since pk-08-08-12
*/
public static function URI_changeGetValue($uri,$name,$value,$debug=False)
{
return pcf_HTML_changeURI_GetValue($uri,$name,$value,$debug);
}
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* @var CMS_PROJECT $myProject
* @access protected
*/
protected $myProject = NULL;
/**
* @var OCSP_AJAX $myAjaxObj
* @access protected
*/
protected $myAjaxObj=NULL;
/*** attributes -------------------------------------------------- */
/**
* @var string $myDocType
* @access protected
*/
protected $myDocType='<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
/**
* @var string $myHtmlTag <html ...>
* @access protected
*/
protected $myHtmlTag="xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"de_DE\" lang=\"de_DE\"";
/**
* http attributes ----------
*/
/**
* an array of http header fields
*
* @var array $myHTTP_headers
* @access protected
* @see http://www.php.net/header
* @see http://www.faqs.org/rfcs/rfc2616
*/
protected $myHTTP_headers=array('Content-Type: text/html; charset=utf-8');
/**
* html header attributes
*/
/**
* @var string $myTitle
* @access protected
*/
protected $myTitle="";
/**
* @var array $myMetaTags
* @access protected
*/
protected $myMetaTags=array(
'Content-Type' => array('EQUIV'=>"Content-Type", 'CONTENT'=>"text/html;charset=utf-8"),
'Content-Script-Type' => array('EQUIV'=>"Content-Script-Type",'CONTENT'=>"text/javascript;charset=utf-8"),
'Content-Style-Type' => array('EQUIV'=>"Content-Style-Type", 'CONTENT'=>"text/css;charset=utf-8")
);
/**
* @var array $myJS_includes
* @access protected
*/
protected $myJS_includes=array('$@SYSTEMURL$javascript/jquery/jquery.js','$@SYSTEMURL$jOCSP/jOCSP.js');
/**
* @var string $myJS_code
* @access protected
*/
protected $myJS_code="";
/**
* @var array $myCSS_includes
* @access protected
*/
protected $myCSS_includes=array();
/**
* @var string $myCSS_code
* @access protected
*/
protected $myCSS_code="";
/**
* @var string $myHeadContent
* @access protected
*/
protected $myHeadContent="";
/**
* html body attributes
*/
/**
* @var string $myBodyTag added to <body .... >
* @access protected
*/
protected $myBodyTag="";
/**
* @var string $myBodyOnload
* @access protected
*/
protected $myBodyOnload="";
/**
* @var string $myJsOnError
* @access protectd
*/
protected $myJsOnError="";
/**
* @var array $myBodyBlocks array of block names in the order the have been added
* @access protected
*/
protected $myBodyBlocks=array();
/**
* @var array $myBodyContent
* @access protected
*/
protected $myBodyContent=array();
/**
* @var array $myBodyVars array of template vars to replace
* @access protected
*/
protected $myTemplateVars=array();
/**
*
* METHODS _____________________________________________
*
*/
/** -----------------------------------------------------
* Constructors
*
* @global $OCSP_OBJ
* @global $OCSP_CONF
*/
function OCSP_HTMLPAGE()
{
global $OCSP_OBJ,$OCSP_CONF;
if (!pcf_is_instance_of($OCSP_OBJ['SESSION'],'OCSP_SESSION'))
{
require_once __OCSP_PHPINCPATH__."common/OCSP_SESSION.phpclass";
$OCSP_OBJ['SESSION']=OCSP_SESSION::getInstance(True);
}
if (!isset($OCSP_CONF['DEFAULT_WINDOW_WIDTH']) || !intval($OCSP_CONF['DEFAULT_WINDOW_WIDTH']))
{
$OCSP_CONF['DEFAULT_WINDOW_WIDTH']=750;
}
if (!isset($OCSP_CONF['DEFAULT_WINDOW_HEIGHT']) || !intval($OCSP_CONF['DEFAULT_WINDOW_HEIGHT']))
{
$OCSP_CONF['DEFAULT_WINDOW_HEIGHT']=550;
}
$myTemplateVars['ALL']=array();
$this->myJS_code="
ocsp_session_name ='".$OCSP_OBJ['SESSION']->getName()."';
ocsp_session_id ='".$OCSP_OBJ['SESSION']->getId()."';
ocsp_conf_winwidth ='".$OCSP_CONF['DEFAULT_WINDOW_WIDTH']."';
ocsp_conf_winheight ='".$OCSP_CONF['DEFAULT_WINDOW_WIDTH']."';
";
$this->addJsSrcLink($OCSP_CONF['JAVASCRIPTURL']."window.js");
$this->addJsSrcLink($OCSP_CONF['JAVASCRIPTURL']."base64.js");
$this->addJsSrcLink($OCSP_CONF['JAVASCRIPTURL']."forms.js");
$this->addJsSrcLink($OCSP_CONF['JAVASCRIPTURL']."ajax.js");
}
/** -----------------------------------------------------
* getter & setter methods
*/
/**
* sets the docType
* @param string $aType HTML Doctype
*/
function setDocType($aType)
{
$this->myDocType=$aType;
}
/**
* HTTP-Header
*/
/**
* appends a HTTP header field
* @param string $field
* @access public
*/
function appendHTTP_header($field)
{
$this->myHTTP_headers[]=$field;
}
/**
* clears the HTTP header fields
* @access public
*/
function clearHTTP_header()
{
$this->myHTTP_headers=array();
}
/**
* HTML head ----------------------------------------------------------------------------------
*/
/**
* sets the title
* @param string $aTitle
* @access public
*/
function setTitle($aTitle)
{
$this->myTitle=$aTitle;
}
/**
* sets a meta tag
*
* @param string $name
* @param string $content
* @param boolean $http_equiv;
*
*/
function setMetaData($name,$content,$http_equiv=False)
{
$this->myMetaTags[$name]=array('CONTENT'=>$content,'EQUIV'=>$http_equiv);
}
/**
* adds a javascript link
* @param string $src
* @access public
*/
function addJsSrcLink($src)
{
if (!in_array($src,$this->myJS_includes))
{
$this->myJS_includes[]=$src;
}
}
/**
* adds a javascript code
* @param string $code
* @param boolean $prepend add the code before already added code
* @param boolean $debug
* @access public
*/
function addJsCode($code,$prepend=False,$debug=False)
{
$code=trim($code);
if (!empty($code))
{
if ($prepend)
{
$this->myJS_code=$code."\n".$this->myJS_code;
} else {
$this->myJS_code.="\n".$code."\n";
}
}
}
/**
* includes a javascript code file into the header
* @param string $file
* @param boolean $prepend add the code before already added code
* @param boolean $debug
* @access public
*/
function addJsFile($file,$prepend=False,$debug=False)
{
if (file_exists($file))
{
$str_code=file_get_contents($file);
if ($prepend)
{
$this->myJS_code=$str_code."\n".$this->myJS_code;
} else {
$this->myJS_code.="\n".$str_code."\n";
}
}
}
/**
* @param string $onErrorCode
* @access public
*/
function setJsOnErrorCode($onErrorCode)
{
$this->myJsOnError=$onErrorCode;
}
/**
* adds a css link
* @param string $src
* @access public
*
* @version pk-07-06-08
*/
function addCssSrcLink($src)
{
if (!empty($src)) // <pk-07-06-08>
{
if (!in_array($src,$this->myCSS_includes))
{
$this->myCSS_includes[]=$src;
}
}
}
/**
* adds a css code
* @param string $code
* @param boolean $prepend add the code before already added code
* @param boolean $debug
* @access public
*/
function addCssCode($code,$prepend=False,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_HTMLPAGE::addCssCode()");
$code=trim($code);
if (!empty($code))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"<pre>".htmlspecialchars($code)."</pre>");
if ($prepend)
{
$this->myCSS_code=$code."\n".$this->myCSS_code;
} else {
$this->myCSS_code.="\n".$code;
}
}
}
/**
* adds a string to the <head>
* @param string $aString
* @access public
*/
function addHeadContent($aString)
{
$this->myHeadContent.=$aString."\n";
}
/**
* adds a file content to the <head>
* @param string $file
* @access public
*/
function addHeadContentFile($file)
{
if (file_exists($file))
{
$str_content=file_get_contents($file);
$this->addHeadContent($str_content);
} else {
$this->addHeadContent("FILE: $file not found",$prepend,$blockName);
}
}
/**
* HTML body ----------------------------------------------------------------------------------
*/
/**
* sets the body tag
* @param string $tag
* @access public
*/
function setBodyTag($tag)
{
$this->myBodyTag=$tag;
}
/**
* sets the body onLoad event
* @param string $jsCmd
*/
function setBodyOnload($jsCmd)
{
$this->myBodyOnload=$jsCmd;
}
/**
* adds a js command to the onLoad of the body
*
* @param string $jsCmd
*
* @since pk-08-04-21
*/
function addBodyOnload($jsCmd)
{
$this->myBodyOnload .= $jsCmd;
}
/**
* @return string
*/
function getBodyOnLoad()
{
return $this->myBodyOnload;
}
/**
* 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 string $code
* @param boolean $prepend
* @param string $blockName
* @access public
*
* @todo OCSP_HTMLPAGE::prepend in array mode
*
*/
function addBodyContent($code,$prepend=False,$blockName='DEFAULT')
{
if (!OCSP_OBJ::isMultiByteStr($code))
{
$code = utf8_encode($code);
}
$blockName=trim($blockName);
if (!empty($blockName) && (!empty($code)))
{
// check if content block is used as array
if (substr($blockName,-2) == "[]")
{
$b_asArray = TRUE;
$blockName = substr($blockName,0,-2);
} else {
$b_asArray = False;
}
if (!in_array($blockName,$this->myBodyBlocks))
{
// add the block to the blocklist
$this->myBodyBlocks[]=$blockName;
}
if (!isset($this->myBodyContent[$blockName]))
{
if ($b_asArray)
{
$this->myBodyContent[$blockName]=array();
} else {
$this->myBodyContent[$blockName]="\n";
}
}
if ($b_asArray) {
$this->myBodyContent[$blockName][]=$code;
} else {
if ($prepend)
{
$this->myBodyContent[$blockName]=$code."\n".$this->myBodyContent[$blockName]."\n";
} else {
$this->myBodyContent[$blockName].="\n".$code."\n";
}
}
}
}
/**
* loads a html code file and adds it to the body by calling $this->addBodyContent()
*
* @param string $file
* @param boolean $prepend
* @param string $blockName
* @access public
*/
function addBodyContentFile($file,$prepend=False,$blockName='DEFAULT',$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_HTMLPAGE::addBodyContentFile({$file});");
if (file_exists($file))
{
$str_content=file_get_contents($file);
if ($debug) echoDebugLine(__FILE__,__LINE__,htmlspecialchars($str_content));
$this->addBodyContent($str_content,$prepend,$blockName);
} else {
$this->addBodyContent("FILE: $file not found",$prepend,$blockName);
}
}
/**
* template vars
*/
/**
* sets a template var if no block is set it's add to 'ALL' and used in all blocks
*
* to add an array set $varName to "" and $varValue to the array
*
* @param string $varName
* @param mixed $varValue
* @param string $blockName
*
* @access public
*
* @version pk-08-04-25
*/
function setTemplateVar($varName,$varValue,$blockName='ALL')
{
if (empty($blockName)) $blockName='ALL';
if (empty($varName) && is_array($varValue))
{
if (!isset($this->myTemplateVars[$blockName]))
{
$this->myTemplateVars[$blockName] = $varValue;
} else {
$this->myTemplateVars[$blockName] = array_merge($this->myTemplateVars[$blockName],$varValue);
}
} else {
$this->myTemplateVars[$blockName][$varName]=$varValue;
}
}
/**
* parses a template var imediatly
*
* @param string $varName
* @param string $varValue
* @param bolean $debug
*/
public function parseTemplateVar($varName,$varValue,$blockName='ALL',$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_HTMLPAGE::parseTemplateVar({$varName});");
$arr_values = array($varName => $varValue);
if ('ALL' == $blockName)
{
foreach($this->myBodyContent as $str_key => $str_tmpl)
{
$obj_tmpl = new OCSP_TEMPLATE($str_tmpl);
$this->myBodyContent[$str_key] = $obj_tmpl->getValueParsedTemplate($arr_values);
}
} else {
$obj_tmpl = new OCSP_TEMPLATE($this->myBodyBlocks[$blockName]);
$this->myBodyContent[$blockName] = $obj_tmpl->getValueParsedTemplate($arr_values);
}
}
/**
* returns a template var
*
* @param string $varName
* @param string $blockName
*
* @return mixed
*
* @since pk-08-01-10
*
*/
function getTemplateVar($varName,$blockName='ALL')
{
if (empty($blockName)) $blockName='ALL';
return $this->myTemplateVars[$blockName][$varName];
}
/**
* ajax -------------------------------------------------------------------
*/
/**
* sets the ajax object of the page
* @param &OCSP_AJAX $ajaxObj
*/
function setAjaxObj(&$ajaxObj)
{
$this->myAjaxObj=$ajaxObj;
}
/**
* returns the ajax object of the page
* @returns OCSP_AJAX
*/
function &getAjaxObj()
{
return $this->myAjaxObj;
}
/** -----------------------------------------------------
* output methods
*/
/**
* returns the HTML head <head>...</head>
*
* @return string
* @access public
*/
function getHtmlHead()
{
$str_ret ="<head>\n";
// title
if (!empty($this->myTitle))
{
$str_ret.="\t<title>".$this->myTitle."</title>\n";
} else if (pcf_is_instance_of($this->myProject,'CMS_PROJECT')) {
$str_ret.="\t<title>".$this->myProject->getTitle()."</title>\n";
} else if (isset($PROJECT['TITLE']) && (!empty($PROJECT['TITLE']))) {
$str_ret.="\t<title>".$PROJECT['TITLE']."</title>\n";
}
// meta
if (is_array($this->myMetaTags))
{
foreach($this->myMetaTags as $str_name => $arr_tag)
{
$str_ret.="\t<meta ";
if ($arr_tag['EQUIV']) {
$str_ret.="http-equiv=\"".$str_name."\" ";
} else {
$str_ret.="name=\"".$str_name."\" ";
}
$str_ret.="content=\"".$arr_tag['CONTENT']."\"";
$str_ret.=" />\n";
}
}
if (!empty($this->myJsOnError))
{
$str_ret.="\n<script type=\"text/javascript\">\n<!--\n";
$str_ret.=$this->myJsOnError;
$str_ret.="\n//-->\n</script>\n\n";
}
// js includes
if (is_array($this->myJS_includes))
{
foreach($this->myJS_includes as $str_src)
{
//$str_src=pcf_HTML_changeURI_GetValue($str_src,session_name(),session_id());
$str_ret.="\t<script language=\"JavaScript\" src=\"".pcf_HTML_getEncodedURI($str_src)."\" type=\"text/javascript\"></script>\n";
}
}
// css includes
if (is_array($this->myCSS_includes))
{
foreach($this->myCSS_includes as $str_src)
{
$str_ret.="\t<link rel=\"stylesheet\" href=\"".$str_src."\" type=\"text/css\" />\n";
}
}
if (!empty($this->myCSS_code))
{
$str_ret.="\n<style type=\"text/css\">\n<!--\n/*<![CDATA[*/\n";
$str_ret.=$this->myCSS_code;
$str_ret.="\n-->\n/*]]*/\n</style>\n\n";
}
if (!empty($this->myJS_code))
{
$str_ret.="\n<script type=\"text/javascript\">\n<!--\n";
$str_ret.=$this->myJS_code;
$str_ret.="\n//-->\n</script>\n\n";
}
if (pcf_is_instance_of($this->myAjaxObj,'OCSP_AJAX')) // the page has an ajax object set
{ // add the ajax wrappers
$str_ret.=$this->myAjaxObj->js_getScript();
}
if ((OCSP_BROWSER::getInstance()->isIE()) && (!OCSP_CONF::getInstance()->getValue('DISABLE_IEPNGFIX')))
{
$str_ret.= "
<!--[if lt IE 7]>
<script defer type=\"text/javascript\" src=\"" . OCSP_CONF::getInstance()->getValue('SYSTEMURL') . "javascript/pngfix.js\"></script>
<![endif]-->
";
}
// other head stuff
$str_ret.=$this->myHeadContent;
$str_ret.="</head>\n\n";
if (isset($this->myTemplateVars['ALL']))
{
$str_ret=pcf_tmpl_parse($str_ret,$this->myTemplateVars['ALL']);
} else if (strstr($str_ret,'$')) {
$str_ret=pcf_tmpl_parse($str_ret,array());
}
return $str_ret;
}
/**
* returns the page content
* this methods returns the whole content for each block the blocks are ordered by there first time set
*
* @param boolean $debug
*
* @return string (html)
*
* @access public
*
* @version pk-08-01-10 avoid parsing the template twice to keep inline templates in forms for example
*/
function getBodyContent($debug=False)
{
$str_ret ="";
if (is_array($this->myBodyBlocks))
{
foreach($this->myBodyBlocks as $int_idx => $str_blockName)
{
if (isset($this->myBodyContent[$str_blockName]))
{
$str_blockContent="\n";
if (is_array($this->myBodyContent[$str_blockName]))
{
foreach($this->myBodyContent[$str_blockName] as $str_content)
{
$str_blockContent.=$str_content."\n";
}
} else {
$str_blockContent.=$this->myBodyContent[$str_blockName];
}
$arr_values=array();
if (isset($this->myTemplateVars['ALL']) && is_array($this->myTemplateVars['ALL']))
{
$arr_values=array_merge($arr_values,$this->myTemplateVars['ALL']);
}
if (isset($this->myTemplateVars[$str_blockName]) && is_array($this->myTemplateVars[$str_blockName]))
{
$arr_values=array_merge($arr_values,$this->myTemplateVars[$str_blockName]);
}
$str_ret.=pcf_tmpl_parse($str_blockContent,$arr_values,$debug);
}
}
}
return $str_ret;
}
/**
* returns the html code of the page
*
* @param boolean $closeBody
*
* @return string
* @access public
*
* @version pk-07-08-08 ankor ocsp_page_top added
*/
function toHtml($closeBody=TRUE)
{
global $PROJECT;
$str_ret="";
$str_ret.=$this->myDocType;
$str_ret.="\n<html ".$this->myHtmlTag.">\n";
$str_ret.=$this->getHtmlHead();
$str_ret.="\n<body id=\"ocspBody\" ".$this->myBodyTag;
if (!empty($this->myBodyOnload)) $str_ret.=" onLoad=\"".$this->myBodyOnload."\" "; // <pk-07-12-19 /> do not escape
$str_ret.=">\n";
$str_ret.="<div style=\"display:none\"><a name=\"ocsp_page_top\"></a></div>\n"; // <pk-07-08-08 />
$str_ret.=$this->getBodyContent()."\n";
if ($closeBody)
{
$str_ret.="</body>\n";
$str_ret.="</html>\n";
}
return $str_ret;
}
/**
* outputs the page
*
* @param boolean $closeBody
* @param string $convertCharSet
*
* @version pk-07-12-14 gzip return
*/
function display($closeBody=true,$convertCharSet="UTF-8")
{
// check output buffers
$arr_ob=ob_list_handlers();
$b_buffer=(sizeof($arr_ob) < 1);
// http header
if (is_array($this->myHTTP_headers) && sizeof($this->myHTTP_headers))
{
foreach($this->myHTTP_headers as $str_header)
{
header($str_header);
}
}
if ($b_buffer) ob_start('ob_gzhandler');
$str_output=$this->toHtml();
//if (!empty($convertCharSet))
//{
// echo mb_convert_encoding($str_output, "UTF-8");
//} else {
// echo $str_output;
//}
echo $str_output;
if ($b_buffer) ob_end_flush();
}
} // end class OCSP_HTMLPAGE
?>

Source for file OCSP_HTMLPAGE.phpclass