Docs For Class tNG

void addColumn(
string
$colName, string
$type, string
$method, string
$reference)

Adds a column to the transaction

Tags:

access:	public
see:	tNG_fields::$columns

Overridden in child classes as:

tNG_custom::addColumn(): Adds a column to the transaction Calls the parent addColumn method then sets the default value.

tNG_insert::addColumn(): Adds a column to the transaction Calls the parent addColumn method then sets the default value.

tNG_import::addColumn(): Adds a column to the transaction Calls the parent addColumn method then sets the default value.

tNG_multipleInsert::addColumn(): Adds a column to the transaction Calls the parent addColumn method then sets the default value.

Parameters:

string	$colName	The column name
string	$type	The column type (NUMERIC_TYPE, STRING_TYPE, etc)
string	$method	The request method (GET, POST, FILE, COOKIE, SESSION)
string	$reference	The submitted variable name (if method=GET and reference=test, value=$_GET['test'])

[ Top ]

boolean afterUpdateField(
string
$fieldName, string
$fieldValue)

Updates a field after the actual transaction was executed

Tags:

return:	true on success false on error
access:	public

Parameters:

string	$fieldName	The field name
string	$fieldValue	The field value

[ Top ]

void compileColumnsValues(
)

Sets for each column the value correspondeing to the reference/method

Tags:

access:

public

[ Top ]

float evaluateNumeric(
string
$expr)

Evaluates a numeric expression

Tags:

return:	- the result of the evaluated expresison.
access:	public

Parameters:

string

$expr

- the expression to be evaluated (must contain only: numbers (0 to 9) and the follwing characters: + - * / . ( )

[ Top ]

void executeTransaction(
)

Evaluates the columns values then executes the Transaction

Tags:

access:

public

Overrides tNG::executeTransaction() (Executes the Transaction Tests the STARTER triggers, executes the BEFORE triggers, the transaction SQL, the AFTER triggers and the END triggers. If error occurs, it executes the ERROR triggers and exits.)

[ Top ]

string getColumnReference(
string
$colName)

Gets the reference of a column

Tags:

access:

public

Parameters:

string

$colName

[ Top ]

string getColumnType(
string
$colName)

Gets the type of a column

Tags:

return:	The column type
access:	public

Parameters:

string

$colName

[ Top ]

object unknown getColumnValue(
string
$colName)

Gets the value of a column

Tags:

access:

public

Parameters:

string

$colName

[ Top ]

object resource getFakeRecordset(
array
$fakeArr)

Creates a fake recordset from the given columns associative array This function is called on error or for the insert default values.

Tags:

return:	Recordset resource
access:	protected

Parameters:

array

$fakeArr

The associative array

[ Top ]

array getFakeRsArr(
)

Creates a fake recordset array from the current $columns

This function is called ONLY on error

Tags:

return:	associative array with the current values.
access:	protected

[ Top ]

string getFieldError(
string
$fName)

Gets the error message for a specific field, if it exists.

Tags:

return:	error message
access:	public

Overridden in child classes as:

tNG_multiple::getFieldError(): Gets the error message for a specific field, if it exists.

Parameters:

string

$fName

the field name

[ Top ]

object resource getLocalRecordset(
)

Get the local recordset associated to this transaction

This function is to be implemented in subclasses

Tags:

return:	Recordset resource
abstract:

Overridden in child classes as:

tNG_custom::getLocalRecordset(): Get the local recordset associated to this transaction

tNG_login::getLocalRecordset(): Get the local recordset associated to this transaction

tNG_delete::getLocalRecordset(): This function exits because the current class does not export a recordset.

tNG_insert::getLocalRecordset(): Get the local recordset associated to this transaction

tNG_multiple::getLocalRecordset(): Abstract method; must be implemented by the inherited classes;

tNG_multipleDelete::getLocalRecordset(): No recordset is created when multiple delete is executed; thus the calling of this method set an error;

tNG_multipleInsert::getLocalRecordset(): Get the local recordset associated to this transaction

tNG_multipleUpdate::getLocalRecordset(): Get the local recordset associated to this transaction

tNG_update::getLocalRecordset(): Get the local recordset associated to this transaction

[ Top ]

string getPrimaryKey(
)

Gets the primary key column

Tags:

access:

public

[ Top ]

object unknown getPrimaryKeyValue(
)

Gets the primary key value

Tags:

access:

public

[ Top ]

object resource getRecordset(
)

Get the recordset associated to this transaction

Tags:

return:	Recordset resource The fake recordset on error or the local recordset
access:	public

Overridden in child classes as:

tNG_multiple::getRecordset(): Get the recordset associated to this transaction

[ Top ]

string getSavedValue(
string
$colName)

Gets the value saved for the given column name

Tags:

access:

public

Overridden in child classes as:

tNG_multiple::getSavedValue(): Wrapper for getSavedValue method of the executed transactions;

Parameters:

string

$colName

the name of the column

[ Top ]

string getTable(
)

Getter for the transaction SQL table

Tags:

return:	The table name
access:	public
see:	tNG_fields::$table

[ Top ]

void &parseSQLError(
string
$sql, mixed
$error, string
$errorMsg)

Parses the SQL error Calls the parent function then sets the error to a specific column if possible.

Tags:

access:

protected

Overrides tNG::parseSQLError() (Parses the SQL error)

Parameters:

string	$sql	the SQL statement that throwed the error message
string	$errorMsg	the error text message

[ Top ]

void prepareSQL(
)

Prepares the SQL query to be executed

To be implemented in derived class

Tags:

access:

protected

Overridden in child classes as:

tNG_custom::prepareSQL(): Prepares the custom SQL query to be executed

tNG_login::prepareSQL(): Prepares the custom SQL query to be executed

tNG_delete::prepareSQL(): Prepares the delete SQL query to be executed

tNG_insert::prepareSQL(): Prepares the insert SQL query to be executed

tNG_import::prepareSQL(): Executes all sub-transactions

tNG_multipleDelete::prepareSQL(): Executes all sub-transactions

tNG_multipleInsert::prepareSQL(): Executes all sub-transactions

tNG_multipleUpdate::prepareSQL(): Executes all sub-transactions

tNG_update::prepareSQL(): Prepares the update SQL query to be executed

Overrides tNG::prepareSQL() (Prepares the SQL query to be executed)

[ Top ]

string saveData(
)

Retrieve and store the saved values from database;

Tags:

access:

public

Overridden in child classes as:

tNG_import::saveData(): No data needs to be saved on insert.

tNG_multipleInsert::saveData(): No data needs to be saved on insert.

[ Top ]

void setColumnValue(
string
$colName, object unknown
$colValue)

Sets a value for a given column

Tags:

access:

public

Parameters:

string	$colName	- the column to alter
object unknown	$colValue	- the new value

[ Top ]

void setPrimaryKey(
string
$colName, string
$type, [string
$method = 'VALUE'], [string
$reference = NULL])

Sets the primary key and its details

Tags:

access:	public
see:	tNG_fields::$primaryKey, tNG_fields::$primaryKeyColumn

Parameters:

string	$colName	The column name
string	$type	The column type (NUMERIC_TYPE, STRING_TYPE, etc)
string	$method	The request method (GET, POST, FILE, COOKIE, SESSION)
string	$reference	The submitted variable name (if method=GET and reference=test, value=$_GET['test'])

[ Top ]

void setRawColumnValue(
string
$colName, object unknown
$colValue)

Sets a value for a column directly

Tags:

access:

public

Parameters:

string	$colName	- the column to alter
object unknown	$colValue	- the new value

[ Top ]

void setTable(
string
$tableName)

Setter for the transaction SQL table

Tags:

access:	public
see:	tNG_fields::$table

Parameters:

string

$tableName

The table name

[ Top ]

Class: tNG_fields

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Class: tNG

Inherited Methods

Class: tNG

Class Details

Tags:

Class Variables

$columns = array()

Tags:

$pkName = 'kt_pk'

Tags:

$primaryKey = ''

Tags:

$primaryKeyColumn = array()

Tags:

$savedData = array()

$table = ''

Tags:

Class Methods

method addColumn [line 73]

Tags:

Parameters:

method afterUpdateField [line 407]

Tags:

Parameters:

method compileColumnsValues [line 268]

Tags:

method evaluateNumeric [line 105]

Tags:

Parameters:

method executeTransaction [line 59]

Tags:

method getColumnReference [line 174]

Tags:

Parameters:

method getColumnType [line 189]

Tags:

Parameters:

method getColumnValue [line 158]

Tags:

Parameters:

method getFakeRecordset [line 300]

Tags:

Parameters:

method getFakeRsArr [line 348]

Tags:

method getFieldError [line 425]

Tags:

Parameters:

method getLocalRecordset [line 289]

Tags:

method getPrimaryKey [line 247]

Tags:

method getPrimaryKeyValue [line 256]

Tags:

method getRecordset [line 321]

Tags:

method getSavedValue [line 438]

Tags:

Parameters:

method getTable [line 222]

Tags:

method parseSQLError [line 385]

Tags:

Parameters:

method prepareSQL [line 336]

Tags:

method saveData [line 450]

Tags:

method setColumnValue [line 128]

Tags:

Parameters:

method setPrimaryKey [line 235]

Tags: