Class: tNG_CheckTableField

Source Location: /tNG3/triggers/tNG_CheckTableField.class.php

Class Overview

Represents the base class for checkDetails and checkMaster classes;

Author(s):

Variables

Methods

Child classes:

tNG_CheckDetailRecord: This the CheckDetailRecord trigger; extends the tNG_CheckTableField class; Checks if exists a master record; it is used inside of a trigger registered to a transaction.

tNG_CheckMasterRecord: This the CheckMasterRecord trigger; extends the tNG_CheckTableField class; Checks if a master record exists; it is used inside of a trigger registered to a transaction.

tNG_CheckUnique: This the CheckUnique trigger; extends the tNG_CheckTableField class; Checks if a value already exists in table.

Class Details

[line 9]
Represents the base class for checkDetails and checkMaster classes;

Tags:

access:

public

[ Top ]

Class Variables

$errorMsg =

[line 45]

The error message to be used;

Tags:

access:

public

Type:

string

[ Top ]

$field =

[line 27]

The field name

Tags:

access:

public

Type:

string

[ Top ]

$table =

[line 21]

The table name

Tags:

var:	table name
access:	public

Type:

string

[ Top ]

$throwErrorIfExists =

[line 51]

if it will be throw error in case the records exists;

Tags:

access:

public

Type:

boolean

[ Top ]

$tNG =

[line 15]

The tNG object

Tags:

access:

public

Type:

object tNG

[ Top ]

$type =

[line 33]

The type of the field

Tags:

access:

public

Type:

string

[ Top ]

$value =

[line 39]

The value of the field

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor tNG_CheckTableField [line 59]

tNG_CheckTableField tNG_CheckTableField(
object tNG
&$tNG)

Constructor. Sets the reference to the transaction in which the trigger is used.

set some defaults values

Tags:

access:

public

Parameters:

object tNG

&$tNG

reference to transaction object

[ Top ]

method errorIfExists [line 111]

nothing errorIfExists(
boolean
$throwErrorIfExists)

setter. if it will be throw error in case the records exists;

Tags:

access:

public

Parameters:

boolean

$throwErrorIfExists

[ Top ]

method Execute [line 130]

mix Execute(
none
0)

execute method of the class;

Tags:

return:	null or error object if records exists and the value of the throwErrorIfExists;
access:	public

Overridden in child classes as:

tNG_CheckDetailRecord::Execute(): execute method of the class; check if detail record exists and return null or error;

tNG_CheckMasterRecord::Execute(): execute method of the class; check if master record exists and return null or error;

tNG_CheckUnique::Execute(): execute method of the class; check if record exists and return null or error;

Parameters:

none

[ Top ]

method setErrorMsg [line 120]

nothing setErrorMsg(
string
$errorMsg)

setter. set the error message

Tags:

access:

public

Parameters:

string

$errorMsg

error message

[ Top ]

method setFieldName [line 84]

nothing setFieldName(
string
$field)

setter. set the field name

Tags:

access:

public

Parameters:

string

$field

field name

[ Top ]

method setFieldType [line 93]

nothing setFieldType(
string
$type)

setter. set the field type

Tags:

access:

public

Parameters:

string

$type

field type

[ Top ]

method setFieldValue [line 102]

nothing setFieldValue(
string
$value)

setter. set the field value

Tags:

access:

public

Parameters:

string

$value

field value

[ Top ]

method setTable [line 74]

nothing setTable(
string
$table)

setter. set the table name

Tags:

access:

public

Parameters:

string

$table

table name

[ Top ]

Documentation generated on Tue, 6 Dec 2005 15:11:35 +0200 by phpDocumentor 1.3.0RC3