Docs For Class OCSP

Description

buffers a html page

author: Peter Krebs <pitlinz@users.sourceforge.net>
version: $Id: OCSP_HTMLPAGE.phpclass,v 1.27 2008/12/10 15:39:05 peterkrebs Exp $
since: pk-07-04-16
project: Open CSP-Management
license: GNU Public License

Located in /common/OCSP_HTMLPAGE.phpclass (line 48)

Direct descendents

Class	Description
OCSP_CMS_HTMLPAGE	Class OCSP_CMS_PEARCACHE.phpclass

Class Constant Summary

CLASS_SRC_FILE = __FILE__

Variable Summary

OCSP_AJAX $myAjaxObj

array $myBodyBlocks

array $myBodyContent

string $myBodyOnload

string $myBodyTag

string $myCSS_code

array $myCSS_includes

string $myDocType

string $myHeadContent

string $myHtmlTag

array $myHTTP_headers

string $myJsOnError

string $myJS_code

array $myJS_includes

array $myMetaTags

CMS_PROJECT $myProject

array $myTemplateVars

string $myTitle

Method Summary

static string URI_changeGetValue (string $uri, string $name, string $value, [boolean $debug = False])

OCSP_HTMLPAGE OCSP_HTMLPAGE ()

void addBodyContent (string $code, [boolean $prepend = False], [string $blockName = 'DEFAULT'])

void addBodyContentFile (string $file, [boolean $prepend = False], [string $blockName = 'DEFAULT'], [ $debug = False])

void addBodyOnload (string $jsCmd)

void addCssCode (string $code, [boolean $prepend = False], [boolean $debug = False])

void addCssSrcLink (string $src)

void addHeadContent (string $aString)

void addHeadContentFile (string $file)

void addJsCode (string $code, [boolean $prepend = False], [boolean $debug = False])

void addJsFile (string $file, [boolean $prepend = False], [boolean $debug = False])

void addJsSrcLink (string $src)

void appendHTTP_header (string $field)

void clearHTTP_header ()

void display ([boolean $closeBody = true], [string $convertCharSet = "UTF-8"])

OCSP_AJAX &getAjaxObj ()

string getBodyContent ([boolean $debug = False])

string getBodyOnLoad ()

string getHtmlHead ()

mixed getTemplateVar (string $varName, [string $blockName = 'ALL'])

void parseTemplateVar (string $varName, string $varValue, [ $blockName = 'ALL'], [bolean $debug = False])

void setAjaxObj ( &$ajaxObj, &OCSP_AJAX $ajaxObj)

void setBodyOnload (string $jsCmd)

void setBodyTag (string $tag)

void setDocType (string $aType)

void setJsOnErrorCode (string $onErrorCode)

void setMetaData (string $name, string $content, [ $http_equiv = False], boolean $http_equiv;)

void setTemplateVar (string $varName, mixed $varValue, [string $blockName = 'ALL'])

void setTitle (string $aTitle)

string toHtml ([boolean $closeBody = TRUE])

Variables

OCSP_AJAX $myAjaxObj = NULL (line 101)

access: protected

array $myBodyBlocks = array() (line 210)

var: array of block names in the order the have been added
access: protected

array $myBodyContent = array() (line 216)

access: protected

string $myBodyOnload = "" (line 198)

access: protected

string $myBodyTag = "" (line 192)

var: added to <body .... >
access: protected

string $myCSS_code = "" (line 176)

access: protected

array $myCSS_includes = array() (line 170)

access: protected

string $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">' (line 110)

access: protected

string $myHeadContent = "" (line 182)

access: protected

string $myHtmlTag = "xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"de_DE\" lang=\"de_DE\"" (line 118)

var: <html ...>
access: protected

array $myHTTP_headers = array('Content-Type: text/html; charset=utf-8') (line 132)

an array of http header fields

string $myJsOnError = "" (line 204)

access: protected

Redefined in descendants as:

OCSP_CMS_HTMLPAGE::$myJsOnError

string $myJS_code = "" (line 164)

access: protected

array $myJS_includes = array('$@SYSTEMURL$javascript/jquery/jquery.js','$@SYSTEMURL$jOCSP/jOCSP.js') (line 158)

access: protected

array $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")) (line 148)

access: protected

CMS_PROJECT $myProject = NULL (line 95)

access: protected

Redefined in descendants as:

OCSP_CMS_HTMLPAGE::$myProject

array $myTemplateVars = array() (line 223)

var: array of template vars to replace
access: protected

string $myTitle = "" (line 142)

access: protected

Methods

static URI_changeGetValue (line 80)

if $name is in URIs Query string the value is replaced otherwise $name=$value is appended to the uri

since: pk-08-08-12
access: public

string URI_changeGetValue (string $uri, string $name, string $value, [boolean $debug = False])

string $uri
string $name
string $value
boolean $debug

Constructor OCSP_HTMLPAGE (line 238)

----------------------------------------------------- Constructors

global: $OCSP_OBJ $OCSP_OBJ:
global: $OCSP_CONF $OCSP_CONF:

OCSP_HTMLPAGE OCSP_HTMLPAGE ()

addBodyContent (line 526)

adds a body content (to a block)

if the blockname ends with [] the content is treaten as array in this case prepend is disabled

todo: OCSP_HTMLPAGE::prepend in array mode
access: public

void addBodyContent (string $code, [boolean $prepend = False], [string $blockName = 'DEFAULT'])

string $code
boolean $prepend
string $blockName

addBodyContentFile (line 582)

loads a html code file and adds it to the body by calling $this->addBodyContent()

access: public

void addBodyContentFile (string $file, [boolean $prepend = False], [string $blockName = 'DEFAULT'], [ $debug = False])

string $file
boolean $prepend
string $blockName
$debug

addBodyOnload (line 499)

adds a js command to the onLoad of the body

since: pk-08-04-21

void addBodyOnload (string $jsCmd)

string $jsCmd

addCssCode (line 424)

adds a css code

access: public

void addCssCode (string $code, [boolean $prepend = False], [boolean $debug = False])

string $code
boolean $prepend: add the code before already added code
boolean $debug

addCssSrcLink (line 406)

adds a css link

version: pk-07-06-08
access: public

void addCssSrcLink (string $src)

string $src

addHeadContent (line 446)

adds a string to the <head>

access: public

void addHeadContent (string $aString)

string $aString

addHeadContentFile (line 457)

adds a file content to the <head>

access: public

void addHeadContentFile (string $file)

string $file

addJsCode (line 355)

adds a javascript code

access: public

void addJsCode (string $code, [boolean $prepend = False], [boolean $debug = False])

string $code
boolean $prepend: add the code before already added code
boolean $debug

addJsFile (line 376)

includes a javascript code file into the header

access: public

void addJsFile (string $file, [boolean $prepend = False], [boolean $debug = False])

string $file
boolean $prepend: add the code before already added code
boolean $debug

addJsSrcLink (line 340)

adds a javascript link

access: public

void addJsSrcLink (string $src)

string $src

appendHTTP_header (line 294)

appends a HTTP header field

access: public

void appendHTTP_header (string $field)

string $field

clearHTTP_header (line 303)

clears the HTTP header fields

access: public

void clearHTTP_header ()

display (line 902)

outputs the page

version: pk-07-12-14 gzip return

void display ([boolean $closeBody = true], [string $convertCharSet = "UTF-8"])

boolean $closeBody
string $convertCharSet

Redefined in descendants as:

OCSP_CMS_HTMLPAGE::display() : outputs the page

getAjaxObj (line 691)

returns the ajax object of the page

OCSP_AJAX &getAjaxObj ()

getBodyContent (line 819)

returns the page content this methods returns the whole content for each block the blocks are ordered by there first time set

return: (html)
version: pk-08-01-10 avoid parsing the template twice to keep inline templates in forms for example
access: public

string getBodyContent ([boolean $debug = False])

boolean $debug

getBodyOnLoad (line 507)

string getBodyOnLoad ()

getHtmlHead (line 706)

returns the HTML head <head>...</head>

access: public

string getHtmlHead ()

getTemplateVar (line 668)

returns a template var

since: pk-08-01-10

mixed getTemplateVar (string $varName, [string $blockName = 'ALL'])

string $varName
string $blockName

parseTemplateVar (line 638)

parses a template var imediatly

access: public

void parseTemplateVar (string $varName, string $varValue, [ $blockName = 'ALL'], [bolean $debug = False])

string $varName
string $varValue
bolean $debug
$blockName

setAjaxObj (line 682)

sets the ajax object of the page

void setAjaxObj ( &$ajaxObj, &OCSP_AJAX $ajaxObj)

&OCSP_AJAX $ajaxObj
&$ajaxObj

setBodyOnload (line 487)

sets the body onLoad event

void setBodyOnload (string $jsCmd)

string $jsCmd

setBodyTag (line 478)

sets the body tag

access: public

void setBodyTag (string $tag)

string $tag

setDocType (line 280)

sets the docType

void setDocType (string $aType)

string $aType: HTML Doctype

setJsOnErrorCode (line 394)

access: public

void setJsOnErrorCode (string $onErrorCode)

string $onErrorCode

setMetaData (line 330)

sets a meta tag

void setMetaData (string $name, string $content, [ $http_equiv = False], boolean $http_equiv;)

string $name
string $content
boolean $http_equiv;
$http_equiv

setTemplateVar (line 613)

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

version: pk-08-04-25
access: public

void setTemplateVar (string $varName, mixed $varValue, [string $blockName = 'ALL'])

string $varName
mixed $varValue
string $blockName

setTitle (line 317)

sets the title

access: public

void setTitle (string $aTitle)

string $aTitle

toHtml (line 869)

returns the html code of the page

version: pk-07-08-08 ankor ocsp_page_top added
access: public

string toHtml ([boolean $closeBody = TRUE])

boolean $closeBody

Class Constants

CLASS_SRC_FILE = __FILE__ (line 57)