Class OCSP_TEMPLATE

Description
Description | Vars (details) | Methods (details) Constants (details)

openCSP class OCSP_TEMPLATE

Located in /common/OCSP_TEMPLATE.phpclass (line 34) 

OCSP_OBJ
   |
   --OCSP_TEMPLATE
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
CLASS_SRC_FILE = __FILE__
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
array $complexVars
string $myTemplate
array $myValues
array $simpleVars
char $varSign
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
static string appendQueryString (string $url, string $queryString)
static array getVars (string $aTemplate, [char $varSign = '$'], [bool $debug = False])
static string parse (string $aTemplate, [array $aArr = NULL], [boolean $debug = False], [char $varSign = '$'])
OCSP_TEMPLATE __construct ([string $aTemplate = Null], [char $varSign = '$'], [boolean $debug = False], array $dataArr)
void getParsedTemplate (array $dataArray, [boolean $debug = False])
void getTmplVars ()
string getValueParsedTemplate (array $dataArray, [boolean $debug = False])
string parseSpecials (string $strTmpl, array $dataArray, boolean $debug)
void setTemplate (string $aTemplate, [boolean $debug = False])
array _checkArray ( &$placeholderPart, string $placeholderPart)
array _checkFormatDate ( &$placeholderPart, string $placeholderPart)
void _checkFormatIntval ( &$placeholderPart, [ $debug = False])
void _checkFormatJavascript ( &$placeholderPart)
void _checkFormatPrintf ( &$placeholderPart)
void _extractVars ( $aTemplate, [ $debug = False])
void _getTemplatePlaceholders (string $aTemplate, [boolean $debug = False])
string _getVarValue (mixed $aValue, array $varDesc, boolean $debug)
void _parseComplex ( $aTmpl,  $dataArray, [ $strict = False], [ $debug = False])
void _parseSimple ( $aTmpl,  $dataArray, [ $strict = False], [ $debug = False])
Variables
Description | Vars (details) Constants (details) | Methods (details)
array $complexVars = array() (line 162)

complex vars

  • var: complexVars
  • access: protected
string $myTemplate = "" (line 133)

the template

  • access: protected
array $myValues = array() (line 140)

the template values to replace

  • access: protected
array $simpleVars = array() (line 155)

simple vars

  • var: simpleVars
  • access: protected
char $varSign = '$' (line 147)

the char sign used (character which encloses the placeholders)

  • access: protected

Inherited Variables

Inherited from OCSP_OBJ

OCSP_OBJ::$global_currentUser
 OCSP_OBJ::$global_defaultDBObj_read
 OCSP_OBJ::$global_defaultDBObj_write
 OCSP_OBJ::$myDBObj
 OCSP_OBJ::$staticClassVars
Methods
Description | Vars (details) Methods (details)
static appendQueryString (line 96)

appends a query string to an url

  • access: public
string appendQueryString (string $url, string $queryString)
  • string $url
  • string $queryString
static getVars (line 64)

returns an array with fields found in the template

each array element has a NAME and a TYPE index

  • access: public
array getVars (string $aTemplate, [char $varSign = '$'], [bool $debug = False])
  • string $aTemplate
  • char $varSign
  • bool $debug
static parse (line 80)

parses a template

  • access: public
string parse (string $aTemplate, [array $aArr = NULL], [boolean $debug = False], [char $varSign = '$'])
  • string $aTemplate
  • array $aArr
  • boolean $debug
  • char $varSign
Constructor __construct (line 176)

construct

  • access: public
OCSP_TEMPLATE __construct ([string $aTemplate = Null], [char $varSign = '$'], [boolean $debug = False], array $dataArr)
  • string $aTemplate
  • array $dataArr
  • char $varSign
  • boolean $debug
getParsedTemplate (line 780)

returns the parsed template

  • access: public
void getParsedTemplate (array $dataArray, [boolean $debug = False])
  • array $dataArray
  • boolean $debug
getTmplVars (line 207)
  • access: public
void getTmplVars ()
getValueParsedTemplate (line 798)

parses only the set values and keeps other placeholders

  • access: public
string getValueParsedTemplate (array $dataArray, [boolean $debug = False])
  • array $dataArray
  • boolean $debug
parseSpecials (line 768)

parse special values of a template

  • access: public
string parseSpecials (string $strTmpl, array $dataArray, boolean $debug)
  • string $strTmpl
  • array $dataArray
  • boolean $debug
setTemplate (line 192)

sets the template

  • access: public
void setTemplate (string $aTemplate, [boolean $debug = False])
  • string $aTemplate
  • boolean $debug
_checkArray (line 299)

checks a subpart of a placeholder if it's an array

  • access: protected
array _checkArray ( &$placeholderPart, string $placeholderPart)
  • string $placeholderPart
  • &$placeholderPart
_checkFormatDate (line 334)

checks if a placeholderPart includes a date format (-D...~VARNAME)

  • access: protected
array _checkFormatDate ( &$placeholderPart, string $placeholderPart)
  • string $placeholderPart
  • &$placeholderPart
_checkFormatIntval (line 394)
  • access: protected
void _checkFormatIntval ( &$placeholderPart, [ $debug = False])
  • &$placeholderPart
  • $debug
_checkFormatJavascript (line 374)
  • access: protected
void _checkFormatJavascript ( &$placeholderPart)
  • &$placeholderPart
_checkFormatPrintf (line 354)
  • access: protected
void _checkFormatPrintf ( &$placeholderPart)
  • &$placeholderPart
_extractVars (line 407)
  • access: protected
void _extractVars ( $aTemplate, [ $debug = False])
  • $aTemplate
  • $debug
_getTemplatePlaceholders (line 240)

extracts the template placeholders out of the template

  • access: protected
void _getTemplatePlaceholders (string $aTemplate, [boolean $debug = False])
  • string $aTemplate
  • boolean $debug
_getVarValue (line 699)

checks the format an returns the proper formated value

  • access: protected
string _getVarValue (mixed $aValue, array $varDesc, boolean $debug)
  • mixed $aValue
  • array $varDesc
  • boolean $debug
_parseComplex (line 543)
  • access: protected
void _parseComplex ( $aTmpl,  $dataArray, [ $strict = False], [ $debug = False])
  • $aTmpl
  • $dataArray
  • $strict
  • $debug
_parseSimple (line 602)
  • access: protected
void _parseSimple ( $aTmpl,  $dataArray, [ $strict = False], [ $debug = False])
  • $aTmpl
  • $dataArray
  • $strict
  • $debug

Inherited Methods

Inherited From OCSP_OBJ

OCSP_OBJ::castObj()
OCSP_OBJ::cloneMe()
OCSP_OBJ::currentUser()
OCSP_OBJ::dbConnect()
OCSP_OBJ::defaultDBObj()
OCSP_OBJ::defaultReadDBObj()
OCSP_OBJ::defaultWriteDBObj()
OCSP_OBJ::getConf()
OCSP_OBJ::getDBObj()
OCSP_OBJ::get_myClassConstant()
OCSP_OBJ::get_myObject_vars()
OCSP_OBJ::get_mySourceFile()
OCSP_OBJ::isConnected()
OCSP_OBJ::isMultiByteStr()
OCSP_OBJ::isUTF8()
OCSP_OBJ::setConf()
OCSP_OBJ::setDBObj()
OCSP_OBJ::set_myObject_vars()
OCSP_OBJ::set_myVarsFrom()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
CLASS_SRC_FILE = __FILE__ (line 43)

Inherited Constants

Inherited from OCSP_OBJ

OCSP_OBJ::CLASS_SRC_FILE

Documentation generated on Thu, 08 Jan 2009 17:47:11 +0100 by phpDocumentor 1.4.0a2