Class: sptpl

Source Location: /sptpl.php

Class sptpl

Class Overview

SpoolTemplate class.

Module to build report from templates. Main class.

Located in /sptpl.php [line 60]

Properties

Methods

[ Top ]

Property Summary

integer	$BlockId	Predefined id, if not specified into block tag.
object DataStorage	$clsDataStorage	Class dataStorage istance
object CPageMgr	$clsPageMgr	Class PageManager istance
object CXml2Array	$Config	Class CXml2Array istance
array	$PrintOrder	Which order use to print all block defined in the current report.
array	$Report	Table of the report definition
string	$TemplateDir	Directory where look for the template files
object DomXML	$TplDom	Dom class of the template file

[ Top ]

Method Summary

sptpl	sptpl()	Initialize this class.
void	LoadTemplate()	Load the specified template file
void	run()	Run the template and made the file
boolean	SetVar()	Set/add a value for data field. This function is an interface to the same function inside the DataManager class, actually it calls that function.
void	_DumpInternals()
boolean	__php5()	Return True if the current PHP version is 5

[ Top ]

Properties

integer $BlockId [line 82]

Predefined id, if not specified into block tag.

[ Top ]

object DataStorage $clsDataStorage [line 94]

Class dataStorage istance

[ Top ]

object CPageMgr $clsPageMgr [line 99]

Class PageManager istance

[ Top ]

object CXml2Array $Config [line 105]

Class CXml2Array istance

This istance holds the configuration file

[ Top ]

array $PrintOrder [line 88]

Which order use to print all block defined in the current report.

For each index the value is the block id (repot index)

[ Top ]

array $Report [line 71]

Table of the report definition

[ Top ]

string $TemplateDir [line 76]

Directory where look for the template files

[ Top ]

object DomXML $TplDom [line 65]

Dom class of the template file

[ Top ]

Methods

Constructor sptpl [line 110]

sptpl sptpl(
)

Initialize this class.

API Tags:

Access:

public

[ Top ]

LoadTemplate [line 139]

void LoadTemplate(
string
$TplFile 
)

Load the specified template file

Parameters:

string

$TplFile:

API Tags:

Access:

public

[ Top ]

run [line 262]

void run(
string
$OutFile 
)

Run the template and made the file

Parameters:

string

$OutFile:

output file name

API Tags:

Access:

public

[ Top ]

SetVar [line 316]

boolean SetVar(
string
$varName, string
$value 
)

Set/add a value for data field. This function is an interface to the same function inside the DataManager class, actually it calls that function.

Parameters:

string	$varName:	data field name
string	$value:	value for data field. It may be an array

API Tags:

Access:

public

[ Top ]

_DumpInternals [line 321]

void _DumpInternals(
)

[ Top ]

__php5 [line 332]

boolean __php5(
)

Return True if the current PHP version is 5

False if is PHP4

API Tags:

Access:

public

[ Top ]

Documentation generated on Mon, 28 Mar 2005 15:13:09 +0200 by phpDocumentor 1.3.0RC3

	SpoolTemplate

[ Back ] [ class tree: SpoolTemplate ] [ index: SpoolTemplate ] [ all elements ]