Class: DataReader

Source Location: /myphp-1.9/myphp-1.9-base/html/util/DataReader.php

Class DataReader

Class Overview

The data carrier.

The Data Reader towards the mysql database and the rendering of the ViewXyz table/form components

 Usage:
   $datareader = new DataReader();
   $datareader->setNumRows($database->getNumRows());
   print $datareader->getNumRows();

Located in /myphp-1.9/myphp-1.9-base/html/util/DataReader.php [line 32]

Properties

Methods

[ Top ]

Property Summary

array	$fieldFlags
array	$fieldLen
array	$fieldName
array	$fieldTable
array	$fieldType
int	$numFields
int	$numRows
boolean	$rc
array	$rows

[ Top ]

Method Summary

DataReader	DataReader()	Constructor
void	add()	Add a row
void	addFieldFlags()
void	addFieldLen()
void	addFieldName()	Add the FieldName, FieldLen, FieldType, FieldFlags, FieldTable
void	addFieldTable()
void	addFieldType()
void	error()	Print or log error messages
String	get()	Get the complete html for a key
String	getClassName()	Returns the name of the instanciated class
void	getFieldFlags()
void	getFieldLen()
void	getFieldName()	Get the FieldName, FieldLen, FieldType, FieldFlags, FieldTable
void	getFieldTable()
void	getFieldType()
void	getNumFields()
void	getNumRows()
void	getRc()	Helper functions
array	getRows()	Return the array of rows
void	set()	Set the named attribute (key) of a class to specified value
void	setNumFields()
void	setNumRows()
void	setRc()

[ Top ]

Properties

array $fieldFlags = array() [line 71]

[ Top ]

array $fieldLen = array() [line 61]

[ Top ]

array $fieldName = array() [line 56]

[ Top ]

array $fieldTable = array() [line 76]

[ Top ]

array $fieldType = array() [line 66]

[ Top ]

int $numFields = '' [line 51]

[ Top ]

int $numRows = '' [line 36]

[ Top ]

boolean $rc = '' [line 41]

[ Top ]

array $rows = array() [line 46]

[ Top ]

Methods

Constructor DataReader [line 81]

DataReader DataReader(
)

Constructor

[ Top ]

add [line 155]

void add(
String
$key, Object
$value, [String
$name = DATA_READER_ROWS] 
)

Add a row

Parameters:

String	$key:	The key to use in the array
String	$name:	The name to use in the class
Object	$value:	The value to add to array

[ Top ]

addFieldFlags [line 237]

void addFieldFlags(
mixed
$key, mixed
$value 
)

[ Top ]

addFieldLen [line 231]

void addFieldLen(
mixed
$key, mixed
$value 
)

[ Top ]

addFieldName [line 228]

void addFieldName(
String
$key, String
$value 
)

Add the FieldName, FieldLen, FieldType, FieldFlags, FieldTable

Parameters:

String	$key:	The key
String	$value:	The value to add

[ Top ]

addFieldTable [line 240]

void addFieldTable(
mixed
$key, mixed
$value 
)

[ Top ]

addFieldType [line 234]

void addFieldType(
mixed
$key, mixed
$value 
)

[ Top ]

error [line 174]

void error(
String
$msg, String
$file, String
$line 
)

Print or log error messages

Parameters:

String	$msg:	The message
String	$file:	The file name
String	$line:	The line number

[ Top ]

get [line 122]

String get(
String
$key, [String
$index = ''], [String
$default = ''] 
)

Get the complete html for a key

Display an error message and exit, If not a known attribute i.e. You MUST define the 'key' at class scope as ... var $mykey='';

Parameters:

String	$key:	The value to return
String	$index:	The index to use, if an array
String	$default:	The default value to use if no match

API Tags:

Return:

the html for the attribute (key)

[ Top ]

getClassName [line 91]

String getClassName(
)

Returns the name of the instanciated class

API Tags:

Return:

The name of the class

[ Top ]

getFieldFlags [line 216]

void getFieldFlags(
[mixed
$index = ''] 
)

[ Top ]

getFieldLen [line 210]

void getFieldLen(
[mixed
$index = ''] 
)

[ Top ]

getFieldName [line 207]

void getFieldName(
[int
$index = ''] 
)

Get the FieldName, FieldLen, FieldType, FieldFlags, FieldTable

Parameters:

int

$index:

The index to get

[ Top ]

getFieldTable [line 219]

void getFieldTable(
[mixed
$index = ''] 
)

[ Top ]

getFieldType [line 213]

void getFieldType(
[mixed
$index = ''] 
)

[ Top ]

getNumFields [line 197]

void getNumFields(
)

[ Top ]

getNumRows [line 191]

void getNumRows(
)

[ Top ]

getRc [line 185]

void getRc(
)

Helper functions

[ Top ]

getRows [line 164]

array getRows(
[int
$index = ''] 
)

Return the array of rows

Parameters:

int

$index:

The index to use

API Tags:

Return:

The array of rows

[ Top ]

set [line 102]

void set(
String
$key, String
$value 
)

Set the named attribute (key) of a class to specified value

Display an error message and exit, If not a known attribute i.e. You MUST define the attribute at class scope as ... var $myattr='';

Parameters:

String	$key:	The key to set
String	$value:	The value of the key

[ Top ]

setNumFields [line 200]

void setNumFields(
mixed
$value 
)

[ Top ]

setNumRows [line 194]

void setNumRows(
mixed
$value 
)

[ Top ]

setRc [line 188]

void setRc(
mixed
$value 
)

[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:05:34 +0100 by phpDocumentor 1.3.0RC3